jkf 0.4.3 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
data/.rubocop.yml CHANGED
@@ -1,1009 +1,8 @@
1
+ inherit_from: .rubocop_todo.yml
2
+
1
3
  AllCops:
2
- Include:
3
- - "**/*.gemspec"
4
- - "**/*.podspec"
5
- - "**/*.jbuilder"
6
- - "**/*.rake"
7
- - "**/*.opal"
8
- - "**/Gemfile"
9
- - "**/Rakefile"
10
- - "**/Capfile"
11
- - "**/Guardfile"
12
- - "**/Podfile"
13
- - "**/Thorfile"
14
- - "**/Vagrantfile"
15
- - "**/Berksfile"
16
- - "**/Cheffile"
17
- - "**/Vagabondfile"
18
- Exclude:
19
- - "vendor/**/*"
20
- - ".bundle/**/*"
21
- DisplayCopNames: false
22
- StyleGuideCopsOnly: false
23
- Style/AccessModifierIndentation:
24
- Description: Check indentation of private/protected visibility modifiers.
25
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-public-private-protected
26
- Enabled: true
27
- EnforcedStyle: indent
28
- SupportedStyles:
29
- - outdent
30
- - indent
31
- Style/AlignHash:
32
- Description: Align the elements of a hash literal if they span more than one line.
33
- Enabled: true
34
- EnforcedHashRocketStyle: key
35
- EnforcedColonStyle: key
36
- EnforcedLastArgumentHashStyle: always_inspect
37
- SupportedLastArgumentHashStyles:
38
- - always_inspect
39
- - always_ignore
40
- - ignore_implicit
41
- - ignore_explicit
42
- Style/AlignParameters:
43
- Description: Align the parameters of a method call if they span more than one line.
44
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-double-indent
45
- Enabled: true
46
- EnforcedStyle: with_first_parameter
47
- SupportedStyles:
48
- - with_first_parameter
49
- - with_fixed_indentation
50
- Style/AndOr:
51
- Description: Use &&/|| instead of and/or.
52
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-and-or-or
53
- Enabled: true
54
- EnforcedStyle: always
55
- SupportedStyles:
56
- - always
57
- - conditionals
58
- Style/BarePercentLiterals:
59
- Description: Checks if usage of %() or %Q() matches configuration.
60
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand
61
- Enabled: true
62
- EnforcedStyle: bare_percent
63
- SupportedStyles:
64
- - percent_q
65
- - bare_percent
66
- Style/BracesAroundHashParameters:
67
- Description: Enforce braces style around hash parameters.
68
- Enabled: true
69
- EnforcedStyle: no_braces
70
- SupportedStyles:
71
- - braces
72
- - no_braces
73
- - context_dependent
74
- Style/CaseIndentation:
75
- Description: Indentation of when in a case/when/[else/]end.
76
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-when-to-case
77
- Enabled: true
78
- IndentWhenRelativeTo: case
79
- SupportedStyles:
80
- - case
81
- - end
82
- IndentOneStep: false
83
- Style/ClassAndModuleChildren:
84
- Description: Checks style of children classes and modules.
85
- Enabled: false
86
- EnforcedStyle: nested
87
- SupportedStyles:
88
- - nested
89
- - compact
90
- Style/ClassCheck:
91
- Description: Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
92
- Enabled: true
93
- EnforcedStyle: is_a?
94
- SupportedStyles:
95
- - is_a?
96
- - kind_of?
97
- Style/CollectionMethods:
98
- Description: Preferred collection methods.
99
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
100
- Enabled: true
101
- PreferredMethods:
102
- collect: map
103
- collect!: map!
104
- find: detect
105
- find_all: select
106
- reduce: inject
107
- Style/CommentAnnotation:
108
- Description: Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK,
109
- REVIEW).
110
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#annotate-keywords
111
- Enabled: false
112
- Keywords:
113
- - TODO
114
- - FIXME
115
- - OPTIMIZE
116
- - HACK
117
- - REVIEW
118
- Style/DotPosition:
119
- Description: Checks the position of the dot in multi-line method calls.
120
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
121
- Enabled: true
122
- EnforcedStyle: trailing
123
- SupportedStyles:
124
- - leading
125
- - trailing
126
- Style/EmptyLineBetweenDefs:
127
- Description: Use empty lines between defs.
128
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods
129
- Enabled: true
130
- AllowAdjacentOneLineDefs: false
131
- Style/EmptyLinesAroundBlockBody:
132
- Description: Keeps track of empty lines around block bodies.
133
- Enabled: true
134
- EnforcedStyle: no_empty_lines
135
- SupportedStyles:
136
- - empty_lines
137
- - no_empty_lines
138
- Style/EmptyLinesAroundClassBody:
139
- Description: Keeps track of empty lines around class bodies.
140
- Enabled: true
141
- EnforcedStyle: no_empty_lines
142
- SupportedStyles:
143
- - empty_lines
144
- - no_empty_lines
145
- Style/EmptyLinesAroundModuleBody:
146
- Description: Keeps track of empty lines around module bodies.
147
- Enabled: true
148
- EnforcedStyle: no_empty_lines
149
- SupportedStyles:
150
- - empty_lines
151
- - no_empty_lines
152
- Style/Encoding:
153
- Description: Use UTF-8 as the source file encoding.
154
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#utf-8
155
- Enabled: false
156
- EnforcedStyle: always
157
- SupportedStyles:
158
- - when_needed
159
- - always
160
- Style/FileName:
161
- Description: Use snake_case for source file names.
162
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
163
- Enabled: false
164
- Exclude: []
165
- Style/FirstParameterIndentation:
166
- Description: Checks the indentation of the first parameter in a method call.
167
- Enabled: true
168
- EnforcedStyle: special_for_inner_method_call_in_parentheses
169
- SupportedStyles:
170
- - consistent
171
- - special_for_inner_method_call
172
- - special_for_inner_method_call_in_parentheses
173
- Style/For:
174
- Description: Checks use of for or each in multiline loops.
175
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-for-loops
176
- Enabled: true
177
- EnforcedStyle: each
178
- SupportedStyles:
179
- - for
180
- - each
181
- Style/FormatString:
182
- Description: Enforce the use of Kernel#sprintf, Kernel#format or String#%.
183
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#sprintf
184
- Enabled: false
185
- EnforcedStyle: format
186
- SupportedStyles:
187
- - format
188
- - sprintf
189
- - percent
190
- Style/GlobalVars:
191
- Description: Do not introduce global variables.
192
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#instance-vars
193
- Enabled: false
194
- AllowedVariables: []
195
- Style/GuardClause:
196
- Description: Check for conditionals that can be replaced with guard clauses
197
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
198
- Enabled: false
199
- MinBodyLength: 1
200
- Style/HashSyntax:
201
- Description: 'Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax { :a =>
202
- 1, :b => 2 }.'
203
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-literals
204
- Enabled: true
205
- EnforcedStyle: ruby19
206
- SupportedStyles:
207
- - ruby19
208
- - hash_rockets
209
- Style/IfUnlessModifier:
210
- Description: Favor modifier if/unless usage when you have a single-line body.
211
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
212
- Enabled: false
213
- MaxLineLength: 80
214
- Style/IndentationWidth:
215
- Description: Use 2 spaces for indentation.
216
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation
217
- Enabled: true
218
- Width: 2
219
- Style/IndentHash:
220
- Description: Checks the indentation of the first key in a hash literal.
221
- Enabled: true
222
- EnforcedStyle: special_inside_parentheses
223
- SupportedStyles:
224
- - special_inside_parentheses
225
- - consistent
226
- Style/LambdaCall:
227
- Description: Use lambda.call(...) instead of lambda.(...).
228
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc-call
229
- Enabled: false
230
- EnforcedStyle: call
231
- SupportedStyles:
232
- - call
233
- - braces
234
- Style/Next:
235
- Description: Use `next` to skip iteration instead of a condition at the end.
236
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
237
- Enabled: false
238
- EnforcedStyle: skip_modifier_ifs
239
- MinBodyLength: 3
240
- SupportedStyles:
241
- - skip_modifier_ifs
242
- - always
243
- Style/NonNilCheck:
244
- Description: Checks for redundant nil checks.
245
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks
246
- Enabled: true
247
- IncludeSemanticChanges: false
248
- Style/MethodDefParentheses:
249
- Description: Checks if the method definitions have or don't have parentheses.
250
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
251
- Enabled: true
252
- EnforcedStyle: require_parentheses
253
- SupportedStyles:
254
- - require_parentheses
255
- - require_no_parentheses
256
- Style/MethodName:
257
- Description: Use the configured style when naming methods.
258
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
259
- Enabled: true
260
- EnforcedStyle: snake_case
261
- SupportedStyles:
262
- - snake_case
263
- - camelCase
264
- Style/MultilineOperationIndentation:
265
- Description: Checks indentation of binary operations that span more than one line.
266
- Enabled: true
267
- EnforcedStyle: aligned
268
- SupportedStyles:
269
- - aligned
270
- - indented
271
- Style/NumericLiterals:
272
- Description: Add underscores to large numeric literals to improve their readability.
273
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics
274
- Enabled: false
275
- MinDigits: 5
276
- Style/ParenthesesAroundCondition:
277
- Description: Don't use parentheses around the condition of an if/unless/while.
278
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-parens-if
279
- Enabled: true
280
- AllowSafeAssignment: true
281
- Style/PercentLiteralDelimiters:
282
- Description: Use `%`-literal delimiters consistently
283
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
284
- Enabled: false
285
- PreferredDelimiters:
286
- "%": "()"
287
- "%i": "()"
288
- "%q": "()"
289
- "%Q": "()"
290
- "%r": "{}"
291
- "%s": "()"
292
- "%w": "()"
293
- "%W": "()"
294
- "%x": "()"
295
- Style/PercentQLiterals:
296
- Description: Checks if uses of %Q/%q match the configured preference.
297
- Enabled: true
298
- EnforcedStyle: lower_case_q
299
- SupportedStyles:
300
- - lower_case_q
301
- - upper_case_q
302
- Style/PredicateName:
303
- Description: Check the names of predicate methods.
304
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
305
- Enabled: true
306
- NamePrefix:
307
- - is_
308
- - has_
309
- - have_
310
- NamePrefixBlacklist:
311
- - is_
312
- Exclude:
313
- - spec/**/*
314
- Style/RaiseArgs:
315
- Description: Checks the arguments passed to raise/fail.
316
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
317
- Enabled: false
318
- EnforcedStyle: exploded
319
- SupportedStyles:
320
- - compact
321
- - exploded
322
- Style/RedundantReturn:
323
- Description: Don't use return where it's not required.
324
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-return
325
- Enabled: true
326
- AllowMultipleReturnValues: false
327
- Style/RegexpLiteral:
328
- Description: Use %r for regular expressions matching more than `MaxSlashes` '/'
329
- characters. Use %r only for regular expressions matching more than `MaxSlashes`
330
- '/' character.
331
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-r
332
- Enabled: false
333
- Style/Semicolon:
334
- Description: Don't use semicolons to terminate expressions.
335
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon
336
- Enabled: true
337
- AllowAsExpressionSeparator: false
338
- Style/SignalException:
339
- Description: Checks for proper usage of fail and raise.
340
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
341
- Enabled: false
342
- EnforcedStyle: semantic
343
- SupportedStyles:
344
- - only_raise
345
- - only_fail
346
- - semantic
347
- Style/SingleLineBlockParams:
348
- Description: Enforces the names of some block params.
349
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
350
- Enabled: false
351
- Methods:
352
- - reduce:
353
- - a
354
- - e
355
- - inject:
356
- - a
357
- - e
358
- Style/SingleLineMethods:
359
- Description: Avoid single-line methods.
360
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
361
- Enabled: false
362
- AllowIfMethodIsEmpty: true
363
- Style/StringLiterals:
364
- Description: Checks if uses of quotes match the configured preference.
365
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
366
- Enabled: true
367
- EnforcedStyle: double_quotes
368
- SupportedStyles:
369
- - single_quotes
370
- - double_quotes
371
- Style/StringLiteralsInInterpolation:
372
- Description: Checks if uses of quotes inside expressions in interpolated strings
373
- match the configured preference.
374
- Enabled: true
375
- EnforcedStyle: single_quotes
376
- SupportedStyles:
377
- - single_quotes
378
- - double_quotes
379
- Style/SpaceAroundBlockParameters:
380
- Description: Checks the spacing inside and after block parameters pipes.
381
- Enabled: true
382
- EnforcedStyleInsidePipes: no_space
383
- SupportedStyles:
384
- - space
385
- - no_space
386
- Style/SpaceAroundEqualsInParameterDefault:
387
- Description: Checks that the equals signs in parameter default assignments have
388
- or don't have surrounding space depending on configuration.
389
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-around-equals
390
- Enabled: true
391
- EnforcedStyle: space
392
- SupportedStyles:
393
- - space
394
- - no_space
395
- Style/SpaceBeforeBlockBraces:
396
- Description: Checks that the left block brace has or doesn't have space before it.
397
- Enabled: true
398
- EnforcedStyle: space
399
- SupportedStyles:
400
- - space
401
- - no_space
402
- Style/SpaceInsideBlockBraces:
403
- Description: Checks that block braces have or don't have surrounding space. For
404
- blocks taking parameters, checks that the left brace has or doesn't have trailing
405
- space.
406
- Enabled: true
407
- EnforcedStyle: space
408
- SupportedStyles:
409
- - space
410
- - no_space
411
- EnforcedStyleForEmptyBraces: no_space
412
- SpaceBeforeBlockParameters: true
413
- Style/SpaceInsideHashLiteralBraces:
414
- Description: Use spaces inside hash literal braces - or don't.
415
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
416
- Enabled: true
417
- EnforcedStyle: space
418
- EnforcedStyleForEmptyBraces: no_space
419
- SupportedStyles:
420
- - space
421
- - no_space
422
- Style/SymbolProc:
423
- Description: Use symbols as procs instead of blocks when possible.
424
- Enabled: true
425
- IgnoredMethods:
426
- - respond_to
427
- Style/TrailingBlankLines:
428
- Description: Checks trailing blank lines and final newline.
429
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#newline-eof
430
- Enabled: true
431
- EnforcedStyle: final_newline
432
- SupportedStyles:
433
- - final_newline
434
- - final_blank_line
435
- Style/TrailingCommaInLiteral:
436
- Enabled: true
437
- Style/TrailingCommaInArguments:
438
- Enabled: true
439
- Style/TrivialAccessors:
440
- Description: Prefer attr_* methods to trivial readers/writers.
441
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr_family
442
- Enabled: false
443
- ExactNameMatch: false
444
- AllowPredicates: false
445
- AllowDSLWriters: false
446
- Whitelist:
447
- - to_ary
448
- - to_a
449
- - to_c
450
- - to_enum
451
- - to_h
452
- - to_hash
453
- - to_i
454
- - to_int
455
- - to_io
456
- - to_open
457
- - to_path
458
- - to_proc
459
- - to_r
460
- - to_regexp
461
- - to_str
462
- - to_s
463
- - to_sym
464
- Style/VariableName:
465
- Description: Use the configured style when naming variables.
466
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
467
- Enabled: true
468
- EnforcedStyle: snake_case
469
- SupportedStyles:
470
- - snake_case
471
- - camelCase
472
- Style/WhileUntilModifier:
473
- Description: Favor modifier while/until usage when you have a single-line body.
474
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier
475
- Enabled: false
476
- MaxLineLength: 80
477
- Style/WordArray:
478
- Description: Use %w or %W for arrays of words.
479
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w
480
- Enabled: false
481
- MinSize: 0
482
- WordRegex: !ruby/regexp /\A[\p{Word}]+\z/
483
- Metrics/AbcSize:
484
- Description: A calculated magnitude based on number of assignments, branches, and
485
- conditions.
486
- Enabled: true
487
- Max: 25
488
- # Max: 15
489
- Metrics/BlockNesting:
490
- Description: Avoid excessive block nesting
491
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count
492
- Enabled: false
493
- Max: 3
494
- Metrics/ClassLength:
495
- Description: Avoid classes longer than 100 lines of code.
496
- Enabled: false
497
- CountComments: false
498
- Max: 100
499
- Metrics/ModuleLength:
500
- Description: Avoid modules longer than 100 lines of code.
501
- Enabled: false
502
- CountComments: false
503
- Max: 100
504
- Metrics/CyclomaticComplexity:
505
- Description: A complexity metric that is strongly correlated to the number of test
506
- cases needed to validate a method.
507
- Enabled: false
508
- Max: 6
509
- Metrics/LineLength:
510
- Description: Limit lines to 100 characters.
511
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits
512
- Enabled: true
513
- Max: 100
514
- AllowURI: true
515
- URISchemes:
516
- - http
517
- - https
518
- Metrics/MethodLength:
519
- Description: Avoid methods longer than 10 lines of code.
520
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
521
- Enabled: false
522
- CountComments: false
523
- Max: 10
524
- Metrics/ParameterLists:
525
- Description: Avoid parameter lists longer than three or four parameters.
526
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
527
- Enabled: false
528
- Max: 5
529
- CountKeywordArgs: true
530
- Metrics/PerceivedComplexity:
531
- Description: A complexity metric geared towards measuring complexity for a human
532
- reader.
533
- Enabled: false
534
- Max: 7
535
- Lint/AssignmentInCondition:
536
- Description: Don't use assignment in conditions.
537
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
538
- Enabled: false
539
- AllowSafeAssignment: true
540
- Lint/EndAlignment:
541
- Description: Align ends correctly.
542
- Enabled: true
543
- AlignWith: keyword
544
- SupportedStyles:
545
- - keyword
546
- - variable
547
- Lint/DefEndAlignment:
548
- Description: Align ends corresponding to defs correctly.
549
- Enabled: true
550
- AlignWith: start_of_line
551
- SupportedStyles:
552
- - start_of_line
553
- - def
554
- Style/InlineComment:
555
- Description: Avoid inline comments.
556
- Enabled: false
557
- Style/MethodCalledOnDoEndBlock:
558
- Description: Avoid chaining a method call on a do...end block.
559
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
560
- Enabled: false
561
- Style/SymbolArray:
562
- Description: Use %i or %I for arrays of symbols.
563
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i
564
- Enabled: false
565
- Style/ExtraSpacing:
566
- Description: Do not use unnecessary spacing.
567
- Enabled: true
568
- Style/AccessorMethodName:
569
- Description: Check the naming of accessor methods for get_/set_.
570
- Enabled: false
571
- Style/Alias:
572
- Description: Use alias_method instead of alias.
573
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
574
- Enabled: false
575
- Style/AlignArray:
576
- Description: Align the elements of an array literal if they span more than one line.
577
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#align-multiline-arrays
578
- Enabled: true
579
- Style/ArrayJoin:
580
- Description: Use Array#join instead of Array#*.
581
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#array-join
582
- Enabled: false
583
- Style/AsciiComments:
584
- Description: Use only ascii symbols in comments.
585
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-comments
586
- Enabled: false
587
- Style/AsciiIdentifiers:
588
- Description: Use only ascii symbols in identifiers.
589
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-identifiers
590
- Enabled: false
591
- Style/Attr:
592
- Description: Checks for uses of Module#attr.
593
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr
594
- Enabled: false
595
- Style/BeginBlock:
596
- Description: Avoid the use of BEGIN blocks.
597
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks
598
- Enabled: true
599
- Style/BlockComments:
600
- Description: Do not use block comments.
601
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-block-comments
602
- Enabled: true
603
- Style/BlockEndNewline:
604
- Description: Put end statement of multiline block on its own line.
605
- Enabled: true
606
- Style/CaseEquality:
607
- Description: Avoid explicit use of the case equality operator(===).
608
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-case-equality
609
- Enabled: false
610
- Style/CharacterLiteral:
611
- Description: Checks for uses of character literals.
612
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-character-literals
613
- Enabled: false
614
- Style/ClassAndModuleCamelCase:
615
- Description: Use CamelCase for classes and modules.
616
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#camelcase-classes
617
- Enabled: true
618
- Style/ClassMethods:
619
- Description: Use self when defining module/class methods.
620
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#def-self-singletons
621
- Enabled: true
622
- Style/ClassVars:
623
- Description: Avoid the use of class variables.
624
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-class-vars
625
- Enabled: false
626
- Style/ColonMethodCall:
627
- Description: 'Do not use :: for method call.'
628
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#double-colons
629
- Enabled: false
630
- Style/CommentIndentation:
631
- Description: Indentation of comments.
632
- Enabled: true
633
- Style/ConstantName:
634
- Description: Constants should use SCREAMING_SNAKE_CASE.
635
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#screaming-snake-case
636
- Enabled: true
637
- Style/DefWithParentheses:
638
- Description: Use def with parentheses when there are arguments.
639
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
640
- Enabled: true
641
- Style/DeprecatedHashMethods:
642
- Description: Checks for use of deprecated Hash methods.
643
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-key
644
- Enabled: false
645
- Style/Documentation:
646
- Description: Document classes and non-namespace modules.
647
- Enabled: false
648
- Style/DoubleNegation:
649
- Description: Checks for uses of double negation (!!).
650
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
651
- Enabled: false
652
- Style/EachWithObject:
653
- Description: Prefer `each_with_object` over `inject` or `reduce`.
654
- Enabled: false
655
- Style/ElseAlignment:
656
- Description: Align elses and elsifs correctly.
657
- Enabled: true
658
- Style/EmptyElse:
659
- Description: Avoid empty else-clauses.
660
- Enabled: true
661
- Style/EmptyLines:
662
- Description: Don't use several empty lines in a row.
663
- Enabled: true
664
- Style/EmptyLinesAroundAccessModifier:
665
- Description: Keep blank lines around access modifiers.
666
- Enabled: true
667
- Style/EmptyLinesAroundMethodBody:
668
- Description: Keeps track of empty lines around method bodies.
669
- Enabled: true
670
- Style/EmptyLiteral:
671
- Description: Prefer literals to Array.new/Hash.new/String.new.
672
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
673
- Enabled: false
674
- Style/EndBlock:
675
- Description: Avoid the use of END blocks.
676
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-END-blocks
677
- Enabled: true
678
- Style/EndOfLine:
679
- Description: Use Unix-style line endings.
680
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#crlf
681
- Enabled: true
682
- Style/EvenOdd:
683
- Description: Favor the use of Fixnum#even? && Fixnum#odd?
684
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods
685
- Enabled: false
686
- Style/FlipFlop:
687
- Description: Checks for flip flops
688
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-flip-flops
689
- Enabled: false
690
- Style/IfWithSemicolon:
691
- Description: Do not use if x; .... Use the ternary operator instead.
692
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs
693
- Enabled: false
694
- Style/IndentationConsistency:
695
- Description: Keep indentation straight.
696
- Enabled: true
697
- Style/IndentArray:
698
- Description: Checks the indentation of the first element in an array literal.
699
- Enabled: true
700
- Style/InfiniteLoop:
701
- Description: Use Kernel#loop for infinite loops.
702
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#infinite-loop
703
- Enabled: true
704
- Style/Lambda:
705
- Description: Use the new lambda literal syntax for single-line blocks.
706
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#lambda-multi-line
707
- Enabled: false
708
- Style/LeadingCommentSpace:
709
- Description: Comments should start with a space.
710
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-space
711
- Enabled: true
712
- Style/LineEndConcatenation:
713
- Description: Use \ instead of + or << to concatenate two string literals at line
714
- end.
715
- Enabled: false
716
- Style/MethodCallParentheses:
717
- Description: Do not use parentheses for method calls with no arguments.
718
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-args-no-parens
719
- Enabled: true
720
- Style/ModuleFunction:
721
- Description: Checks for usage of `extend self` in modules.
722
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
723
- Enabled: false
724
- Style/MultilineBlockChain:
725
- Description: Avoid multi-line chains of blocks.
726
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
727
- Enabled: true
728
- Style/MultilineBlockLayout:
729
- Description: Ensures newlines after multiline block do statements.
730
- Enabled: true
731
- Style/MultilineIfThen:
732
- Description: Do not use then for multi-line if/unless.
733
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-then
734
- Enabled: true
735
- Style/MultilineTernaryOperator:
736
- Description: 'Avoid multi-line ?: (the ternary operator); use if/unless instead.'
737
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary
738
- Enabled: true
739
- Style/NegatedIf:
740
- Description: Favor unless over if for negative conditions (or control flow or).
741
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#unless-for-negatives
742
- Enabled: false
743
- Style/NegatedWhile:
744
- Description: Favor until over while for negative conditions.
745
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#until-for-negatives
746
- Enabled: false
747
- Style/NestedTernaryOperator:
748
- Description: Use one expression per branch in a ternary operator.
749
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-ternary
750
- Enabled: true
751
- Style/NilComparison:
752
- Description: Prefer x.nil? to x == nil.
753
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods
754
- Enabled: false
755
- Style/Not:
756
- Description: Use ! instead of not.
757
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#bang-not-not
758
- Enabled: false
759
- Style/OneLineConditional:
760
- Description: Favor the ternary operator(?:) over if/then/else/end constructs.
761
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
762
- Enabled: false
763
- Style/OpMethod:
764
- Description: When defining binary operators, name the argument other.
765
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#other-arg
766
- Enabled: false
767
- Style/PerlBackrefs:
768
- Description: Avoid Perl-style regex back references.
769
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
770
- Enabled: false
771
- Style/Proc:
772
- Description: Use proc instead of Proc.new.
773
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc
774
- Enabled: false
775
- Style/RedundantBegin:
776
- Description: Don't use begin blocks when they are not needed.
777
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#begin-implicit
778
- Enabled: true
779
- Style/RedundantException:
780
- Description: Checks for an obsolete RuntimeException argument in raise/fail.
781
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-runtimeerror
782
- Enabled: true
783
- Style/RedundantSelf:
784
- Description: Don't use self where it's not needed.
785
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-self-unless-required
786
- Enabled: true
787
- Style/RescueModifier:
788
- Description: Avoid using rescue in its modifier form.
789
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers
790
- Enabled: true
791
- Style/SelfAssignment:
792
- Description: Checks for places where self-assignment shorthand should have been
793
- used.
794
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#self-assignment
795
- Enabled: false
796
- Style/SpaceBeforeFirstArg:
797
- Description: Checks that exactly one space is used between a method name and the
798
- first argument for method calls without parentheses.
799
- Enabled: true
800
- Style/SpaceAfterColon:
801
- Description: Use spaces after colons.
802
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
803
- Enabled: true
804
- Style/SpaceAfterComma:
805
- Description: Use spaces after commas.
806
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
807
- Enabled: true
808
- Style/SpaceAroundKeyword:
809
- Description: Use spaces after if/elsif/unless/while/until/case/when.
810
- Enabled: true
811
- Style/SpaceAfterMethodName:
812
- Description: Do not put a space between a method name and the opening parenthesis
813
- in a method definition.
814
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces
815
- Enabled: true
816
- Style/SpaceAfterNot:
817
- Description: Tracks redundant space after the ! operator.
818
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-bang
819
- Enabled: true
820
- Style/SpaceAfterSemicolon:
821
- Description: Use spaces after semicolons.
822
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
823
- Enabled: true
824
- Style/SpaceBeforeComma:
825
- Description: No spaces before commas.
826
- Enabled: true
827
- Style/SpaceBeforeComment:
828
- Description: Checks for missing space between code and a comment on the same line.
829
- Enabled: true
830
- Style/SpaceBeforeSemicolon:
831
- Description: No spaces before semicolons.
832
- Enabled: true
833
- Style/SpaceAroundOperators:
834
- Description: Use spaces around operators.
835
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
836
- Enabled: true
837
- Style/SpaceAroundKeyword:
838
- Description: Put a space before the modifier keyword.
839
- Enabled: true
840
- Style/SpaceInsideBrackets:
841
- Description: No spaces after [ or before ].
842
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
843
- Enabled: true
844
- Style/SpaceInsideParens:
845
- Description: No spaces after ( or before ).
846
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
847
- Enabled: true
848
- Style/SpaceInsideRangeLiteral:
849
- Description: No spaces inside range literals.
850
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals
851
- Enabled: true
852
- Style/SpecialGlobalVars:
853
- Description: Avoid Perl-style global variables.
854
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
855
- Enabled: false
856
- Style/StructInheritance:
857
- Description: Checks for inheritance from Struct.new.
858
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new
859
- Enabled: true
860
- Style/Tab:
861
- Description: No hard tabs.
862
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation
863
- Enabled: true
864
- # trailing whitespace in here-doc
865
- Style/TrailingWhitespace:
866
- Description: Avoid trailing whitespace.
867
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace
868
- Enabled: false
869
- # Enabled: true
870
- Style/UnlessElse:
871
- Description: Do not use unless with else. Rewrite these with the positive case first.
872
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-else-with-unless
873
- Enabled: true
874
- Style/UnneededCapitalW:
875
- Description: Checks for %W when interpolation is not needed.
876
- Enabled: true
877
- Style/UnneededPercentQ:
878
- Description: Checks for %q/%Q when single quotes or double quotes would do.
879
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q
880
- Enabled: true
881
- Style/VariableInterpolation:
882
- Description: Don't interpolate global, instance and class variables directly in
883
- strings.
884
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
885
- Enabled: false
886
- Style/WhenThen:
887
- Description: Use when x then ... for one-line cases.
888
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
889
- Enabled: false
890
- Style/WhileUntilDo:
891
- Description: Checks for redundant do after while or until.
892
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-while-do
893
- Enabled: true
894
- Lint/AmbiguousOperator:
895
- Description: Checks for ambiguous operators in the first argument of a method invocation
896
- without parentheses.
897
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-as-args
898
- Enabled: false
899
- Lint/AmbiguousRegexpLiteral:
900
- Description: Checks for ambiguous regexp literals in the first argument of a method
901
- invocation without parenthesis.
902
- Enabled: false
903
- Lint/BlockAlignment:
904
- Description: Align block ends correctly.
905
- Enabled: true
906
- Lint/ConditionPosition:
907
- Description: Checks for condition placed in a confusing position relative to the
908
- keyword.
909
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#same-line-condition
910
- Enabled: false
911
- Lint/Debugger:
912
- Description: Check for debugger calls.
913
- Enabled: true
914
- Lint/DeprecatedClassMethods:
915
- Description: Check for deprecated class method calls.
916
- Enabled: false
917
- Lint/DuplicateMethods:
918
- Description: Check for duplicate methods calls.
919
- Enabled: true
920
- Lint/ElseLayout:
921
- Description: Check for odd code arrangement in an else block.
922
- Enabled: false
923
- Lint/EmptyEnsure:
924
- Description: Checks for empty ensure block.
925
- Enabled: true
926
- Lint/EmptyInterpolation:
927
- Description: Checks for empty string interpolation.
928
- Enabled: true
929
- Lint/EndInMethod:
930
- Description: END blocks should not be placed inside method definitions.
931
- Enabled: true
932
- Lint/EnsureReturn:
933
- Description: Do not use return in an ensure block.
934
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-return-ensure
935
- Enabled: true
936
- Lint/Eval:
937
- Description: The use of eval represents a serious security risk.
938
- Enabled: true
939
- Lint/HandleExceptions:
940
- Description: Don't suppress exception.
941
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
942
- Enabled: false
943
- Lint/InvalidCharacterLiteral:
944
- Description: Checks for invalid character literals with a non-escaped whitespace
945
- character.
946
- Enabled: false
947
- Lint/LiteralInCondition:
948
- Description: Checks of literals used in conditions.
949
- Enabled: false
950
- Lint/LiteralInInterpolation:
951
- Description: Checks for literals used in interpolation.
952
- Enabled: false
953
- Lint/Loop:
954
- Description: Use Kernel#loop with break rather than begin/end/until or begin/end/while
955
- for post-loop tests.
956
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#loop-with-break
957
- Enabled: false
958
- Lint/ParenthesesAsGroupedExpression:
959
- Description: Checks for method calls with a space before the opening parenthesis.
960
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces
961
- Enabled: false
962
- Lint/RequireParentheses:
963
- Description: Use parentheses in the method call to avoid confusion about precedence.
964
- Enabled: false
965
- Lint/RescueException:
966
- Description: Avoid rescuing the Exception class.
967
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-blind-rescues
968
- Enabled: true
969
- Lint/ShadowingOuterLocalVariable:
970
- Description: Do not use the same name as outer local variable for block arguments
971
- or block local variables.
972
- Enabled: true
973
- Lint/StringConversionInInterpolation:
974
- Description: Checks for Object#to_s usage in string interpolation.
975
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-to-s
976
- Enabled: true
977
- Lint/UnderscorePrefixedVariableName:
978
- Description: Do not use prefix `_` for a variable that is used.
979
- Enabled: false
980
- Lint/UnusedBlockArgument:
981
- Description: Checks for unused block arguments.
982
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
983
- Enabled: true
984
- Lint/UnusedMethodArgument:
985
- Description: Checks for unused method arguments.
986
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
987
- Enabled: true
988
- Lint/UnreachableCode:
989
- Description: Unreachable code.
990
- Enabled: true
991
- Lint/UselessAccessModifier:
992
- Description: Checks for useless access modifiers.
993
- Enabled: true
994
- Lint/UselessAssignment:
995
- Description: Checks for useless assignment to a local variable.
996
- StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
997
- Enabled: true
998
- Lint/UselessComparison:
999
- Description: Checks for comparison of something with itself.
1000
- Enabled: true
1001
- Lint/UselessElseWithoutRescue:
1002
- Description: Checks for useless `else` in `begin..end` without `rescue`.
1003
- Enabled: true
1004
- Lint/UselessSetterCall:
1005
- Description: Checks for useless setter call to a local variable.
1006
- Enabled: true
1007
- Lint/Void:
1008
- Description: Possible use of operator/literal/variable in void context.
1009
- Enabled: false
4
+ NewCops: enable
5
+
6
+ require:
7
+ - rubocop-rake
8
+ - rubocop-rspec