simplycop 1.14.5 → 1.14.7

data/.simplycop_lint.yml

@@ -0,0 +1,415 @@
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+# Overridden to false in Chopin
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+# Overridden to false in Chopin
+Lint/AmbiguousRange:
+  Enabled: true
+
+# TODO: One fail on rater spec then would pass
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/AssignmentInCondition:
+  Enabled: true
+  
+Lint/BigDecimalNew:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/BooleanSymbol:
+  Enabled: true
+
+Lint/CircularArgumentReference:
+  Enabled: true
+
+# TODO: 6 fails in Rater, otherwise clear
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+
+# Set to false as 10000s of fails on Rater and Chopin if enabled
+# Rubocop docs suggest enabling only for constants that may cause concern
+# so enable and set these if required
+Lint/ConstantResolution:
+  Enabled: false 
+
+Lint/Debugger:
+  Enabled: true 
+
+Lint/DeprecatedClassMethods:
+  Enabled: true 
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DisjunctiveAssignmentInConstructor:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateCaseCondition:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateHashKey:
+  Enabled: true
+
+Lint/DuplicateMagicComment:
+  Enabled: true
+
+Lint/DuplicateMatchPattern:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true 
+
+Lint/EmptyEnsure:
+  Enabled: true 
+
+Lint/EmptyExpression:
+  Enabled: true 
+
+Lint/EmptyFile:
+  Enabled: true 
+
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true 
+
+Lint/EmptyInterpolation:
+  Enabled: true 
+
+Lint/EmptyWhen:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true 
+
+Lint/FlipFlop:
+  Enabled: true 
+
+Lint/FloatComparison:
+  Enabled: true 
+
+Lint/FloatOutOfRange:
+  Enabled: true 
+
+Lint/FormatParameterMismatch:
+  Enabled: true 
+
+Lint/HashCompareByIdentity:
+  Enabled: true 
+
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+
+Lint/IdentityComparison:
+  Enabled: true 
+
+Lint/ImplicitStringConcatenation:
+  Enabled: true 
+
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+
+# TODO: two fails on Rater, one on CoCo, otherwise fine
+Lint/IneffectiveAccessModifier:
+  Enabled: true 
+
+Lint/InheritException:
+  Enabled: true 
+
+Lint/InterpolationCheck:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/LiteralAsCondition:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+
+Lint/MissingCopEnableDirective:
+  Enabled: true
+
+# TODO: Handful of errors on Rater and CoCo
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedCaseRange:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/MultipleComparison:
+  Enabled: true
+
+Lint/NestedMethodDefinition:
+  Enabled: true
+
+Lint/NestedPercentLiteral:
+  Enabled: true
+
+Lint/NextWithoutAccumulator:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+# Overridden to false in Chopin
+Lint/NonAtomicFileOperation:
+  Enabled: true
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: true 
+
+Lint/NonLocalExitFromIterator:
+  Enabled: true 
+
+Lint/NumberConversion:
+  Enabled: false 
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/OrderedMagicComments:
+  Enabled: true 
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true 
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true 
+
+Lint/PercentStringArray:
+  Enabled: true 
+
+Lint/PercentSymbolArray:
+  Enabled: true 
+
+Lint/RaiseException:
+  Enabled: true 
+
+Lint/RandOne:
+  Enabled: true 
+
+Lint/RedundantCopDisableDirective:
+  Enabled: true 
+
+Lint/RedundantCopEnableDirective:
+  Enabled: true 
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RedundantRegexpQuantifiers:
+  Enabled: true
+
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+Lint/RedundantSafeNavigation:
+  Enabled: true
+
+Lint/RedundantSplatExpansion:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/RedundantWithIndex:
+  Enabled: true
+
+Lint/RedundantWithObject:
+  Enabled: true
+
+Lint/RefinementImportMethods:
+  Enabled: true
+
+Lint/RegexpAsCondition:
+  Enabled: true
+
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RequireRangeParentheses:
+  Enabled: true
+
+# Overridden to false in Chopin
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/RescueType:
+  Enabled: true
+
+Lint/ReturnInVoidContext:
+  Enabled: true
+
+Lint/SafeNavigationChain:
+  Enabled: true
+
+Lint/SafeNavigationConsistency:
+  Enabled: true
+
+Lint/SafeNavigationWithEmpty:
+  Enabled: true
+
+Lint/ScriptPermission:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/SendWithMixinArgument:
+  Enabled: true
+
+Lint/ShadowedArgument:
+  Enabled: true
+
+Lint/ShadowedException:
+  Enabled: true
+
+# Needs Chopin override
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/SuppressedException:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/Syntax:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/ToJSON:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnifiedInteger:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UriRegexp:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/UselessElseWithoutRescue:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+# TODO: Single fail on Chopin
+Lint/UselessRescue:
+  Enabled: true
+
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Enabled: true
+
+Lint/UselessTimes:
+  Enabled: true
+
+Lint/Void:
+  Enabled: true

data/.simplycop_metrics.yml

@@ -0,0 +1,38 @@
+# Metrics cops are enabled by default with the expectation that many repos will 
+# have to set their own limits or disable. #technical-excellence-community discussion
+# suggested some liked to work from them, and that overriding should be a conscious decision
+
+Metrics/AbcSize:
+  Enabled: true
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/BlockNesting:
+  Enabled: true
+
+Metrics/ClassLength:
+  Enabled: true
+
+Metrics/CollectionLiteralLength:
+  Enabled: true 
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+
+Metrics/MethodLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/ModuleLength:
+  Enabled: true
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Enabled: true

data/.simplycop_migration.yml

@@ -0,0 +1,2 @@
+Migration/DepartmentName:
+  Enabled: true

data/.simplycop_naming.yml

@@ -0,0 +1,81 @@
+# Needs override or fix in Chopin
+Naming/AccessorMethodName:
+  Enabled: true
+
+Naming/AsciiIdentifiers:
+  Enabled: true
+
+Naming/BinaryOperatorParameterName:
+  Enabled: true
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Naming/BlockParameterName:
+  Enabled: true
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+Naming/ConstantName:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true
+
+Naming/HeredocDelimiterCase:
+  Enabled: true
+
+Naming/HeredocDelimiterNaming:
+  Enabled: true
+
+Naming/InclusiveLanguage:
+  Enabled: true
+
+# Need override - 86 fails on Chopin
+Naming/MemoizedInstanceVariableName:
+  Enabled: true
+
+Naming/MethodName:
+  Enabled: true
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames:
+    - as
+    - at
+    - ex
+    - id
+    - ip
+    - n
+    - to
+
+Naming/PredicateName:
+  Enabled: true
+  ForbiddenPrefixes: []
+
+# Need Chopin override
+Naming/RescuedExceptionsVariableName:
+  Enabled: true
+
+Naming/VariableName:
+  Enabled: true
+
+# snake_case: 311 fails on Chopin, normalcase: 1118 fails on Chopin
+# snake_case default on Rater so make default in simplycop
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+  AllowedIdentifiers:
+    - capture3
+    - e164
+    - iso8601 
+    - oauth2
+    - rfc1123_date
+    - rfc822
+    - rfc2822
+    - rfc3339
+    - s3
+    - x86_64
+  AllowedPatterns:
+    - v\d+

data/.simplycop_rspec.yml

@@ -126,6 +126,9 @@ RSpec/ExpectInHook:
 RSpec/ExpectOutput:
   Enabled: false
 
+RSpec/FilePath:
+  Enabled: false
+
 RSpec/Focus:
   Enabled: true
 
@@ -186,7 +189,7 @@ RSpec/MessageSpies:
   Enabled: false
 
 RSpec/MetadataStyle:
-  Enabled: true
+  Enabled: false
 
 RSpec/MissingExampleGroupArgument:
   Enabled: true
@@ -280,12 +283,12 @@ RSpec/SkipBlockInsideExample:
 RSpec/SortMetadata:
   Enabled: true
 
-RSpec/SpecFilePathSuffix:
-  Enabled: false
-
 RSpec/SpecFilePathFormat:
   Enabled: false
 
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
 RSpec/StubbedMock:
   Enabled: false
 
@@ -315,15 +318,19 @@ RSpec/Yield:
 
 # Rspec/Capybara
 
+# Similar to FactoryBot (see below) there is an RSpec/Capybara department and a separate Capybara
+# package which is not installed in simplycop. This configuration is just for the RSpec department.
+# The namespacing has been changed to avoid warnings. 
+
 RSpec/Capybara:
   Enabled: true
   Include:
     - spec/integration/*.rb
 
-RSpec/Capybara/FeatureMethods:
+Capybara/CurrentPathExpectation:
   Enabled: true
 
-Capybara/CurrentPathExpectation:
+RSpec/Capybara/FeatureMethods:
   Enabled: true
 
 Capybara/MatchStyle:
@@ -341,11 +348,13 @@ Capybara/SpecificFinders:
 Capybara/SpecificMatcher:
   Enabled: true
 
-# RSpec/FactoryBot
-
-FactoryBot/AssociationStyle:
+Capybara/VisibilityMatcher:
   Enabled: true
 
+# RSpec/FactoryBot
+# NB: There is an RSpec/FactoryBot department and a separate FactoryBot package. The FactoryBot package is 
+# not installed on simplycop. The configuration is just for the RSpec department, namespaced to avoid warnings.
+
 FactoryBot/AttributeDefinedStatically:
   Enabled: true
 
@@ -355,22 +364,51 @@ FactoryBot/ConsistentParenthesesStyle:
 FactoryBot/CreateList:
   Enabled: false
 
-FactoryBot/FactoryAssociationWithStrategy:
-  Enabled: true
-
 FactoryBot/FactoryClassName:
   Enabled: true
 
 FactoryBot/FactoryNameStyle:
   Enabled: true
 
-FactoryBot/RedundantFactoryOption:
-  Enabled: true
-
 # Prefer explicit factorybot call
 FactoryBot/SyntaxMethods:
   Enabled: false
 
+# Previously some FactoryBot package cops were configured due to the above confusion. There is less crossover between 
+# RSpec/FactoryBot and FactoryBot than Capybara, so it generated a number of errors when they weren't found.
+# This is how they were configured:
+
+# FactoryBot/AssociationStyle:
+#   Enabled: true
+
+# FactoryBot/AttributeDefinedStatically:
+#   Enabled: true
+
+# FactoryBot/ConsistentParenthesesStyle:
+#   Enabled: true
+
+# FactoryBot/CreateList:
+#   Enabled: false
+
+# FactoryBot/FactoryAssociationWithStrategy:
+#   Enabled: true
+
+# FactoryBot/FactoryClassName:
+#   Enabled: true
+
+# FactoryBot/FactoryNameStyle:
+#   Enabled: true
+
+# FactoryBot/IdSequence:
+#   Enabled: true
+
+# FactoryBot/RedundantFactoryOption:
+#   Enabled: true
+
+# # Prefer explicit factorybot call
+# FactoryBot/SyntaxMethods:
+#   Enabled: false
+
 # Rspec/Rails
 
 RSpec/Rails/AvoidSetupHook: # new in 2.4

data/.simplycop_security.yml

@@ -3,6 +3,8 @@ require:
   - './lib/simplycop/security/reject_all_requests_local.rb'
   - './lib/simplycop/security/check_for_vulnerable_code.rb'
 
+# Custom security cops
+
 Security/CSRFTokenValidation:
   Enabled: true
   Details: >-
@@ -20,3 +22,31 @@ Security/CheckForVulnerableCode:
   Details: >-
     Please make sure that this is addressed accordingly.
     Do not hesitate to contact infosec for help and guidance
+
+# Standard security cops
+    
+# Overridden to false in Chopin
+Security/CompoundHash:
+  Enabled: true
+
+Security/Eval:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+
+# Overridden to false on Chopin
+Security/IoMethods:
+  Enabled: true
+
+# Needs override in chopin spec
+Security/JSONLoad:
+  Enabled: true
+
+Security/MarshalLoad:
+  Enabled: true
+
+Security/Open:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true