-
Notifications
You must be signed in to change notification settings - Fork 32
/
.rubocop.yml
1367 lines (1113 loc) · 47.9 KB
/
.rubocop.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require:
- rubocop-performance
- rubocop-rails
- rubocop-rspec
AllCops:
TargetRailsVersion: 7.0
NewCops: enable
Exclude:
- 'db/**/*'
- 'bin/*'
- 'config/puma.rb'
- 'node_modules/**/*'
- 'vendor/bundle/**/*'
Rails:
Enabled: true
#################### Layout ###########################
Layout/BeginEndAlignment:
Description: This cop checks whether the end keyword of begin is aligned properly.
StyleGuide: https://docs.rubocop.org/rubocop/cops_layout.html#layoutbeginendalignment
EnforcedStyleAlignWith: begin
Enabled: true
Layout/DotPosition:
Description: 'Checks the position of the dot in multi-line method calls.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
EnforcedStyle: leading
Layout/EmptyLinesAroundAttributeAccessor:
Enabled: true
Layout/EndAlignment:
Description: "This cop checks whether the end keywords are aligned properly."
StyleGuide: https://docs.rubocop.org/rubocop/cops_layout.html#layoutendalignment
AutoCorrect: true
Enabled: true
Layout/ExtraSpacing:
Description: 'Do not use unnecessary spacing.'
Enabled: true
Layout/InitialIndentation:
Description: >-
Checks the indentation of the first non-blank non-comment line in a file.
Enabled: true
Layout/LineLength:
Description: 'Limit lines to 80 characters.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
Max: 80
Include:
- 'app/**/*'
- 'lib/**/*'
- 'spec/**/*'
Exclude:
- spec/spec_helper.rb
Layout/MultilineOperationIndentation:
Description: >-
Checks indentation of binary operations that span more than one line.
Enabled: true
EnforcedStyle: indented
Layout/MultilineMethodCallIndentation:
Description: >-
Checks indentation of method calls with the dot operator
that span more than one line.
Enabled: true
EnforcedStyle: indented
Layout/ParameterAlignment:
Description: 'Here we check if the parameters on a multi-line method call or definition are aligned.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
Enabled: true
Layout/SpaceAroundMethodCallOperator:
Enabled: true
#################### Lint ##################################
Lint/AmbiguousOperator:
Description: >-
Checks for ambiguous operators in the first argument of a
method invocation without parentheses.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args'
Enabled: true
Lint/AmbiguousRegexpLiteral:
Description: >-
Checks for ambiguous regexp literals in the first argument of
a method invocation without parenthesis.
Enabled: true
Lint/AssignmentInCondition:
Description: "Don't use assignment in conditions."
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition'
Enabled: true
Lint/BinaryOperatorWithIdenticalOperands:
Description: "This cop checks for places where binary operator has identical operands."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintbinaryoperatorwithidenticaloperands
Enabled: true
Lint/CircularArgumentReference:
Description: "Don't refer to the keyword argument in the default value."
Enabled: true
Lint/DeprecatedClassMethods:
Description: 'Check for deprecated class method calls.'
Enabled: true
Lint/DeprecatedOpenSSLConstant:
Description: 'Algorithmic constants for OpenSSL::Cipher and OpenSSL::Digest deprecated since OpenSSL version 2.2.0. Prefer passing a string instead.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_lint.html#lintdeprecatedopensslconstant'
Enabled: true
Lint/DuplicateElsifCondition:
Description: "This cop checks that there are no repeated conditions used in if 'elsif'."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintduplicateelsifcondition
Enabled: true
Lint/DuplicateHashKey:
Description: 'Check for duplicate keys in hash literals.'
Enabled: true
Lint/DuplicateRescueException:
Description: "This cop checks that there are no repeated exceptions used in 'rescue' expressions."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintduplicaterescueexception
Enabled: true
Lint/EachWithObjectArgument:
Description: 'Check for immutable argument given to each_with_object.'
Enabled: true
Lint/ElseLayout:
Description: 'Check for odd code arrangement in an else block.'
Enabled: true
Lint/EmptyConditionalBody:
Description: "This cop checks for the presence of if, elsif and unless branches without a body."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintemptyconditionalbody
Enabled: true
Lint/FlipFlop:
Description: "Checks for flip flops"
StyleGuide: "https://github.com/bbatsov/ruby-style-guide#no-flip-flops"
Enabled: true
Lint/FloatComparison:
Description: "This cop checks for the presence of precise comparison of floating point numbers."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintfloatcomparison
Enabled: true
Lint/FormatParameterMismatch:
Description: 'The number of parameters to format/sprint must match the fields.'
Enabled: true
Lint/LiteralInInterpolation:
Description: 'Checks for literals used in interpolation.'
Enabled: true
Lint/Loop:
Description: >-
Use Kernel#loop with break rather than begin/end/until or
begin/end/while for post-loop tests.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
Enabled: false
Lint/MissingSuper:
Description: "This cop checks for the presence of constructors and lifecycle callbacks without calls to super."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintmissingsuper
Enabled: true
Lint/MixedRegexpCaptureTypes:
Description: 'Do not mix named captures and numbered captures in a Regexp literal because numbered capture is ignored if they’re mixed. Replace numbered captures with non-capturing groupings or named captures.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_lint.html#lintmixedregexpcapturetypes'
Enabled: true
Lint/NestedMethodDefinition:
Description: 'Do not use nested method definitions.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
Enabled: true
Lint/NonLocalExitFromIterator:
Description: 'Do not use return in iterator to cause non-local exit.'
Enabled: true
Lint/OutOfRangeRegexpRef:
Description: "This cop looks for references of Regexp captures that are out of range and thus always returns nil."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintoutofrangeregexpref
Enabled: true
Lint/ParenthesesAsGroupedExpression:
Description: >-
Checks for method calls with a space before the opening
parenthesis.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
Enabled: true
Lint/RaiseException:
Enabled: true
Lint/RequireParentheses:
Description: >-
Use parentheses in the method call to avoid confusion
about precedence.
Enabled: false
Lint/SelfAssignment:
Description: "This cop checks for self-assignments."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintselfassignment
Enabled: true
Lint/StructNewOverride:
Enabled: true
Lint/SuppressedException:
Description: "Don't suppress exception."
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
Enabled: false
Lint/TopLevelReturnWithArgument:
Description: "This cop checks for top level return with arguments. If there is a top-level return statement with an argument, then the argument is always ignored. This is detected automatically since Ruby 2.7."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#linttoplevelreturnwithargument
Enabled: true
Lint/UnderscorePrefixedVariableName:
Description: 'Do not use prefix `_` for a variable that is used.'
Enabled: true
Lint/UnreachableLoop:
Description: "This cop checks for loops that will have at most one iteration."
StyleGuide: https://docs.rubocop.org/rubocop/cops_lint.html#lintunreachableloop
Enabled: true
Lint/Void:
Description: 'Possible use of operator/literal/variable in void context.'
Enabled: false
#################### Metrics ###############################
Metrics/AbcSize:
Description: >-
A calculated magnitude based on number of assignments,
branches, and conditions.
Enabled: false
Metrics/BlockLength:
IgnoredMethods: ['describe', 'context', 'shared_examples']
Exclude:
- config/environments/**
Metrics/BlockNesting:
Description: 'Avoid excessive block nesting'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
Enabled: true
Exclude:
- spec/spec_helper.rb
Metrics/ClassLength:
Description: 'Avoid classes longer than 100 lines of code.'
Enabled: false
Metrics/CyclomaticComplexity:
Description: >-
A complexity metric that is strongly correlated to the number
of test cases needed to validate a method.
Enabled: true
Metrics/MethodLength:
Description: 'Avoid methods longer than 10 lines of code.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
Enabled: true
Style/ModuleFunction:
Description: 'Checks for usage of `extend self` in modules.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function'
Enabled: true
Metrics/ModuleLength:
Description: 'Avoid modules longer than 100 lines of code.'
Enabled: false
Metrics/ParameterLists:
Description: 'Avoid parameter lists longer than three or four parameters.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
Enabled: true
#################### Naming ###############################
Naming/AccessorMethodName:
Description: Check the naming of accessor methods for get_/set_.
Enabled: false
Naming/AsciiIdentifiers:
Description: 'Use only ascii symbols in identifiers.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'
Enabled: false
Naming/BinaryOperatorParameterName:
Description: 'When defining binary operators, name the argument other.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
Enabled: true
Naming/FileName:
Description: 'Use snake_case for source file names.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
Enabled: true
Naming/PredicateName:
Description: 'Check the names of predicate methods.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
ForbiddenPrefixes:
- is_
Exclude:
- spec/**/*
#################### Performance ###########################
Performance/AncestorsInclude:
Description: 'This cop is used to identify usages of ancestors.include? and change them to use ⇐ instead.'
StyleGuide: 'https://docs.rubocop.org/rubocop-performance/cops_performance.html#performanceancestorsinclude'
Enabled: true
Performance/BigDecimalWithNumericArgument:
Description: 'This cop identifies places where numeric argument to BigDecimal should be converted to string. Initializing from String is faster than from Numeric for BigDecimal.'
StyleGuide: 'https://docs.rubocop.org/rubocop-performance/cops_performance.html#performancebigdecimalwithnumericargument'
Enabled: true
Performance/CaseWhenSplat:
Description: >-
Place `when` conditions that use splat at the end
of the list of `when` branches.
Enabled: true
Performance/Count:
Description: >-
Use `count` instead of `select...size`, `reject...size`,
`select...count`, `reject...count`, `select...length`,
and `reject...length`.
Enabled: true
Performance/Detect:
Description: >-
Use `detect` instead of `select.first`, `find_all.first`,
`select.last`, and `find_all.last`.
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
Enabled: true
Performance/FlatMap:
Description: >-
Use `Enumerable#flat_map`
instead of `Enumerable#map...Array#flatten(1)`
or `Enumberable#collect..Array#flatten(1)`
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code'
Enabled: true
Performance/RedundantMerge:
Description: >-
This cop identifies places where `Hash#merge!` can be replaced
by `Hash#[]=`.
Enabled: true
Performance/RedundantSortBlock:
Description: 'This cop identifies places where sort { |a, b| a <=> b } can be replaced with sort.'
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performanceredundantsortblock
Enabled: true
Performance/RedundantStringChars:
Description: 'This cop checks for redundant String#chars.'
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performanceredundantstringchars
Enabled: true
Performance/ReverseEach:
Description: 'Use `reverse_each` instead of `reverse.each`.'
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
Enabled: true
Performance/ReverseFirst:
Description: 'This cop identifies places where reverse.first(n) and reverse.first can be replaced by last(n).reverse and last.'
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performancereversefirst
Enabled: true
Performance/Size:
Description: >-
Use `size` instead of `count` for counting
the number of elements in `Array` and `Hash`.
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code'
Enabled: true
Performance/SortReverse:
Description: 'This cop identifies places where sort { |a, b| b <⇒ a } can be replaced by a faster sort.reverse.'
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performancesortreverse
Enabled: true
Performance/Squeeze:
Description: "This cop identifies places where gsub(/a+/, 'a') and gsub!(/a+/, 'a') can be replaced by squeeze('a') and squeeze!('a'). The squeeze('a') method is faster than gsub(/a+/, 'a')."
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performancesqueeze
Enabled: true
Performance/StringInclude:
Description: 'This cop identifies unnecessary use of a regex where String#include? would suffice.'
StyleGuide: https://docs.rubocop.org/rubocop-performance/cops_performance.html#performancestringinclude
Enabled: true
Performance/StringReplacement:
Description: >-
Use `tr` instead of `gsub` when you are replacing the same
number of characters. Use `delete` instead of `gsub` when
you are deleting characters.
Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
Enabled: true
#################### Rails #################################
Rails/ActionFilter:
Description: 'Enforces consistent use of action filter methods.'
Enabled: true
Rails/ActiveRecordCallbacksOrder:
Description: "This cop checks that Active Record callbacks are declared in the order in which they will be executed."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsactiverecordcallbacksorder
Enabled: true
Rails/Date:
Description: >-
Checks the correct usage of date aware methods,
such as Date.today, Date.current etc.
Enabled: true
Rails/Delegate:
Description: 'Prefer delegate method for delegations.'
Enabled: false
Rails/EnvironmentVariableAccess:
Description: 'This cop looks for direct access to environment variables through the ENV variable within the application code.'
AllowReads: true
Enabled: true
Rails/FindBy:
Description: 'Prefer find_by over where.first.'
Enabled: true
Rails/FindById:
Description: "This cop enforces that ActiveRecord#find is used instead of where.take!, find_by!, and find_by_id! to retrieve a single record by primary key when you expect it to be found."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsfindbyid
Enabled: true
Rails/FindEach:
Description: 'Prefer all.find_each over all.find.'
Enabled: true
Rails/HasAndBelongsToMany:
Description: 'Prefer has_many :through to has_and_belongs_to_many.'
Enabled: false
Rails/Inquiry:
Description: "This cop checks that Active Support’s inquiry method is not used."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsinquiry
Enabled: true
Rails/MailerName:
Description: "This cop enforces that mailer names end with Mailer suffix."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsmailername
Enabled: true
Rails/MatchRoute:
Description: "This cop identifies places where defining routes with match can be replaced with a specific HTTP method."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsmatchroute
Enabled: true
Rails/NegateInclude:
Description: "This cop enforces the use of collection.exclude?(obj) over !collection.include?(obj)."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsnegateinclude
Enabled: true
Rails/Output:
Description: 'Checks for calls to puts, print, etc.'
Enabled: true
Rails/Pluck:
Description: "This cop enforces the use of pluck over map."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railspluck
Enabled: true
Rails/PluckInWhere:
Description: "This cop identifies places where pluck is used in where query methods and can be replaced with select."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railspluckinwhere
Enabled: true
Rails/ReadWriteAttribute:
Description: >-
Checks for read_attribute(:attr) and
write_attribute(:attr, val).
Enabled: false
Rails/RenderInline:
Description: "This cop looks for inline rendering within controller actions."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsrenderinline
Enabled: true
Rails/RenderPlainText:
Description: "This cop identifies places where render text: can be replaced with render plain:."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsrenderplaintext
Enabled: true
Rails/ScopeArgs:
Description: 'Checks the arguments of ActiveRecord scopes.'
Enabled: true
Rails/ShortI18n:
Description: "This cop enforces that short forms of I18n methods are used: t instead of translate and l instead of localize."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railsshorti18n
Enabled: true
Rails/TimeZone:
Description: 'Checks the correct usage of time zone aware methods.'
StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
Enabled: true
Rails/Validation:
Description: 'Use validates :attribute, hash of validations.'
Enabled: true
Rails/WhereExists:
Description: "This cop enforces the use of exists?(...) over where(...).exists?."
StyleGuide: https://docs.rubocop.org/rubocop-rails/2.7/cops_rails.html#railswhereexists
Enabled: true
#################### Style ###########################
Style/AccessorGrouping:
Description: 'This cop checks for grouping of accessors in class and module bodies. By default it enforces accessors to be placed in grouped declarations, but it can be configured to enforce separating them in multiple declarations.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_style.html#styleaccessorgrouping'
Enabled: true
Style/ArrayCoercion:
Description: "This cop enforces the use of Array() instead of explicit Array check or [*var]."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylearraycoercion
Enabled: true
Style/ArrayJoin:
Description: 'Use Array#join instead of Array#*.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#array-join'
Enabled: true
Style/AsciiComments:
Description: 'Use only ascii symbols in comments.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
Enabled: false
Style/Attr:
Description: 'Checks for uses of Module#attr.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr'
Enabled: false
Style/BisectedAttrAccessor:
Description: 'This cop checks for places where attr_reader and attr_writer for the same method can be combined into single attr_accessor.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_style.html#stylebisectedattraccessor'
Enabled: true
Style/CaseEquality:
Description: 'Avoid explicit use of the case equality operator(===).'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-case-equality'
Enabled: false
Style/CaseLikeIf:
Description: "This cop identifies places where if-elsif constructions can be replaced with case-when."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylecaselikeif
Enabled: true
Style/CharacterLiteral:
Description: 'Checks for uses of character literals.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
Enabled: false
Style/ClassAndModuleChildren:
Description: 'Checks style of children classes and modules.'
Enabled: true
EnforcedStyle: nested
Style/ClassVars:
Description: 'Avoid the use of class variables.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
Enabled: true
Style/CollectionMethods:
Enabled: true
PreferredMethods:
find: detect
inject: reduce
collect: map
find_all: select
Style/ColonMethodCall:
Description: 'Do not use :: for method call.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
Enabled: true
Style/CommentAnnotation:
Description: >-
Checks formatting of special comments
(TODO, FIXME, OPTIMIZE, HACK, REVIEW).
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#annotate-keywords'
Enabled: true
Style/PreferredHashMethods:
Description: 'Checks use of `has_key?` and `has_value?` Hash methods.'
StyleGuide: '#hash-key'
Enabled: true
Style/Documentation:
Description: 'Document classes and non-namespace modules.'
Enabled: false
Style/DoubleNegation:
Description: 'Checks for uses of double negation (!!).'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
Enabled: false
Style/EachWithObject:
Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
Enabled: true
Style/EmptyLiteral:
Description: 'Prefer literals to Array.new/Hash.new/String.new.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#literal-array-hash'
Enabled: true
# Checks whether the source file has a utf-8 encoding comment or not
# AutoCorrectEncodingComment must match the regex
# /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
Style/Encoding:
Enabled: false
Style/EvenOdd:
Description: 'Favor the use of Fixnum#even? && Fixnum#odd?'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
Enabled: true
Style/ExplicitBlockArgument:
Description: "This cop enforces the use of explicit block argument to avoid writing block literal that just passes its arguments to another block."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#styleexplicitblockargument
Enabled: true
Style/ExponentialNotation:
Enabled: true
Style/FrozenStringLiteralComment:
Description: >-
Add the frozen_string_literal comment to the top of files
to help transition from Ruby 2.3.0 to Ruby 3.0.
Enabled: true
Style/FormatString:
Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
Enabled: false
Style/GlobalStdStream:
Description: "This cop enforces the use of $stdout/$stderr/$stdin instead of STDOUT/STDERR/STDIN."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#styleglobalstdstream
Enabled: true
Style/GlobalVars:
Description: 'Do not introduce global variables.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html'
Enabled: true
Style/GuardClause:
Description: 'Check for conditionals that can be replaced with guard clauses'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
Enabled: true
Style/HashAsLastArrayItem:
Description: "Checks for presence or absence of braces around hash literal as a last array item depending on configuration."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylehashaslastarrayitem
Enabled: true
Style/HashEachMethods:
Description: 'Use Hash#each_key and Hash#each_value.'
StyleGuide: 'https://github.com/rubocop-hq/ruby-style-guide#hash-each'
Enabled: true
Style/HashLikeCase:
Description: "This cop checks for places where case-when represents a simple 1:1 mapping and can be replaced with a hash lookup."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylehashlikecase
Enabled: true
Style/HashSyntax:
Description: 'This cop checks hash literal syntax'
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylehashsyntax
EnforcedShorthandSyntax: either
Style/HashTransformKeys:
Description: 'Prefer `transform_keys` over `each_with_object` and `map`.'
StyleGuide: 'https://github.com/rubocop-hq/ruby-style-guide#hashtransform_keys-and-hashtransform_values'
Enabled: true
Style/HashTransformValues:
Description: 'Prefer `transform_values` over `each_with_object` and `map`.'
StyleGuide: 'https://github.com/rubocop-hq/ruby-style-guide#hashtransform_keys-and-hashtransform_values'
Enabled: true
Style/IfUnlessModifier:
Description: >-
Favor modifier if/unless usage when you have a
single-line body.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
Enabled: true
Style/IfWithSemicolon:
Description: 'Do not use if x; .... Use the ternary operator instead.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs'
Enabled: true
Style/InlineComment:
Description: 'Avoid inline comments.'
Enabled: false
Style/Lambda:
Description: 'Use the new lambda literal syntax for single-line blocks.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line'
Enabled: true
Style/LambdaCall:
Description: 'Use lambda.call(...) instead of lambda.(...).'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call'
Enabled: false
Style/LineEndConcatenation:
Description: >-
Use \ instead of + or << to concatenate two string literals at
line end.
Enabled: true
Style/MultilineBlockChain:
Description: 'Avoid multi-line chains of blocks.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
Enabled: false
Style/NegatedIf:
Description: >-
Favor unless over if for negative conditions
(or control flow or).
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives'
Enabled: true
Style/NegatedWhile:
Description: 'Favor until over while for negative conditions.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives'
Enabled: true
Style/Next:
Description: 'Use `next` to skip iteration instead of a condition at the end.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
Enabled: true
Style/NilComparison:
Description: 'Prefer x.nil? to x == nil.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
Enabled: true
Style/Not:
Description: 'Use ! instead of not.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bang-not-not'
Enabled: true
Style/NumericLiterals:
Description: >-
Add underscores to large numeric literals to improve their
readability.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
Enabled: true
Style/OneLineConditional:
Description: >-
Favor the ternary operator(?:) over
if/then/else/end constructs.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
Enabled: true
Style/OptionalBooleanParameter:
Description: "This cop checks for places where keyword arguments can be used instead of boolean arguments when defining methods."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#styleoptionalbooleanparameter
Enabled: true
Style/PercentLiteralDelimiters:
Description: 'Use `%`-literal delimiters consistently'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces'
PreferredDelimiters:
default: ()
Style/PerlBackrefs:
Description: 'Avoid Perl-style regex back references.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
Enabled: false
Style/Proc:
Description: 'Use proc instead of Proc.new.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc'
Enabled: false
Style/RaiseArgs:
Description: 'Checks the arguments passed to raise/fail.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages'
Style/RedundantAssignment:
Description: 'This cop checks for redundant assignment before returning.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_style.html#styleredundantassignment'
Enabled: true
Style/RedundantFetchBlock:
Description: 'This cop identifies places where fetch(key) { value } can be replaced by fetch(key, value).'
StyleGuide: 'https://docs.rubocop.org/rubocop/0.86/cops_style.html#styleredundantfetchblock'
Enabled: true
Style/RedundantFileExtensionInRequire:
Description: "This cop checks for the presence of superfluous .rb extension in the filename provided to require and require_relative."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#styleredundantfileextensioninrequire
Enabled: true
Style/RedundantRegexpCharacterClass:
Description: 'This cop checks for unnecessary single-element Regexp character classes.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_style.html#styleredundantregexpcharacterclass'
Enabled: true
Style/RedundantRegexpEscape:
Description: 'This cop checks for redundant escapes inside Regexp literals.'
StyleGuide: 'https://docs.rubocop.org/rubocop/cops_style.html#styleredundantregexpescape'
Enabled: true
Style/RegexpLiteral:
Description: 'Use / or %r around regular expressions.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
Enabled: true
Style/SelfAssignment:
Description: >-
Checks for places where self-assignment shorthand should have
been used.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment'
Enabled: true
Style/SingleArgumentDig:
Description: "Sometimes using dig method ends up with just a single argument. In such cases, dig should be replaced with []."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylesingleargumentdig
Enabled: true
Style/SingleLineBlockParams:
Description: 'Enforces the names of some block params.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#reduce-blocks'
Enabled: false
Style/SingleLineMethods:
Description: 'Avoid single-line methods.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-single-line-methods'
Enabled: false
Style/SignalException:
Description: 'Checks for proper usage of fail and raise.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method'
Enabled: true
Style/SlicingWithRange:
Enabled: true
Style/SpecialGlobalVars:
Description: 'Avoid Perl-style global variables.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms'
Enabled: false
Style/StringConcatenation:
Description: "This cop checks for places where string concatenation can be replaced with string interpolation."
StyleGuide: https://docs.rubocop.org/rubocop/cops_style.html#stylestringconcatenation
Enabled: true
Style/StringLiterals:
Description: 'Checks if uses of quotes match the configured preference.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
EnforcedStyle: single_quotes
Enabled: true
Style/TrivialAccessors:
Description: 'Prefer attr_* methods to trivial readers/writers.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr_family'
Enabled: true
Style/VariableInterpolation:
Description: >-
Don't interpolate global, instance and class variables
directly in strings.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#curlies-interpolate'
Enabled: true
Style/WhenThen:
Description: 'Use when x then ... for one-line cases.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#one-line-cases'
Enabled: true
Style/WhileUntilModifier:
Description: >-
Favor modifier while/until usage when you have a
single-line body.
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier'
Enabled: true
Style/WordArray:
Description: 'Use %w or %W for arrays of words.'
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
Enabled: false
Style/Sample:
Description: >-
Use `sample` instead of `shuffle.first`,
`shuffle.last`, and `shuffle[Fixnum]`.
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
Enabled: true
Style/TrailingCommaInArguments:
EnforcedStyleForMultiline: 'comma'
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: 'comma'
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: 'comma'
#################### Testing ###########################
RSpec/AnyInstance:
Description: Check that instances are not being stubbed globally.
Enabled: true
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AnyInstance
RSpec/AroundBlock:
Description: Checks that around blocks actually run the test.
Enabled: true
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AroundBlock
RSpec/AlignLeftLetBrace:
Description: Checks that left braces for adjacent single line lets are aligned.
Enabled: false
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AlignLeftLetBrace
RSpec/AlignRightLetBrace:
Description: Checks that right braces for adjacent single line lets are aligned.
Enabled: false
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AlignRightLetBrace
RSpec/Be:
Description: Check for expectations where `be` is used without argument.
Enabled: true
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Be
RSpec/BeEql:
Description: Check for expectations where `be(...)` can replace `eql(...)`.
Enabled: true
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeEql
RSpec/BeforeAfterAll:
Description: Check that before/after(:all) isn't being used.
Enabled: true
Exclude:
- spec/spec_helper.rb
- spec/rails_helper.rb
- spec/support/**/*.rb
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeforeAfterAll
RSpec/ContextWording:
Description: "`context` block descriptions should start with 'when', or 'with'."
Enabled: false
Prefixes:
- when
- with
- without
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ContextWording
RSpec/DescribeClass:
Description: Check that the first argument to the top level describe is a constant.
Enabled: true
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
Exclude:
- spec/system/**
RSpec/DescribedClass:
Description: Checks that tests use `described_class`.
SkipBlocks: false
Enabled: true
EnforcedStyle: described_class
SupportedStyles:
- described_class
- explicit
StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClass