house_style 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e5114e9c83f5b90caceb9be694f39637960c5795e9f9246666302be796836d
-  data.tar.gz: 7633b076ec8d475f44675cbcbbb215d5423e7c5159c9096aa4f8aa916ecc6a07
+  metadata.gz: 4c7d73723e1623f63dc207e459d60607779a0337f292376ea84994364c8ebaad
+  data.tar.gz: bff167b4593dfe8050a119e77b8faec1b1f852718151610dd21aa6e765d2e488
 SHA512:
-  metadata.gz: bef45d1bc0b477eac9da7d8525b2202cc0fb6f80cf14908bdecdcf988a16021e8454f701d645d3c26a34502693b6aa97a89c6357b91fdc33a1280cafdae4f8a6
-  data.tar.gz: 80177fd9d2e22aec9f3c8f33749d1b9d44113cd72c9ce5233212d8d740a6c0aeff3c2d6679ee0af622a2e3f829c686435d28267022e25a8c7299f676411eea8e
+  metadata.gz: e0007ffa7833fef6f6c04b51c0e5ae92b4ef986aa5d56a8998553af189d6a438fc5d7d1aba7d32b85f56cee2b807bd36933c48a2c2de0391f29232ca042f7ed3
+  data.tar.gz: 7c72f7a747f8702aa44f71910e41791d26b4573bd89c3eabce9954e7ddd6769e2b6c9d7e724915f31949c78e14eaf667d85aba544b8e0ad563e5a83429470571

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # CHANGELOG
 
-## CURRENT
+## 3.0.0
+### Bug fixes
+- Change the Rails template so the require for the rspec plugin is done in the main .rubocop.yml file. Otherwise generating the TODO doesn't work properly.
+### Changes
+- Disable all cops by default (including the new ones), and specifically set the enabled ones.
+- Remove rubocop-rake plugin.
+- Reduce the number of configuration files, `rubocop.yml` will include the cops configuration for each environment/plugin
+- Set mininum Rubocop version to 1.31 (which includes rubocop server). Relax rubocop version restriction, as it should remain compatible on 1.x branch now that we allow specific cops only.
+- Relax plugin versions
+- Autocorrect disabled for Rspec/Focus
+- Allow numbers at the end of block parameter names
+- Be quite relaxed with Layout/LineLength cop, ignore patterns related to strings/descriptions/logs and encourage autocorrection.
 
 ## 2.3.0
 ### Changes

data/features/rubocop.yml

@@ -2,14 +2,6 @@ inherit_from: ../ruby/rubocop.yml
 
 Layout/LineLength:
   Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
 Style/BlockDelimiters:
   Exclude:
     - factories/**/*
-Style/Documentation:
-  Enabled: false
-Style/WordArray:
-  Enabled: false

data/house_style.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'house_style'
-  spec.version       = '2.3.0'
+  spec.version       = '3.0.0'
   spec.authors       = ['Altmetric', 'Scott Matthewman']
   spec.email         = ['engineering@altmetric.com', 'scott.matthewman@gmail.com']
 
@@ -15,11 +15,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|.gitignore|)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '>= 1.0', '< 1.23'
-  spec.add_dependency 'rubocop-performance', '~> 1.11.3'
-  spec.add_dependency 'rubocop-rails', '~> 2.12.3'
-  spec.add_dependency 'rubocop-rake', '< 1.0'
-  spec.add_dependency 'rubocop-rspec', '~> 2.5.0'
+  spec.add_dependency 'rubocop', '>= 1.31', '< 2.0'
+  spec.add_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_dependency 'rubocop-rails', '~> 2.12'
+  spec.add_dependency 'rubocop-rspec', '~> 2.5'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/generators/house_style/templates/rspec_rubocop.yml

@@ -1,5 +1,3 @@
 inherit_from: ../.rubocop.yml
 inherit_gem:
   house_style: rspec/rubocop.yml
-
-require: rubocop-rspec

data/lib/generators/house_style/templates/rubocop.yml

@@ -1,2 +1,4 @@
 inherit_gem:
   house_style: rails/rubocop.yml
+
+require: rubocop-rspec

data/performance/rubocop.yml

@@ -1,4 +1,59 @@
-inherit_from:
-  - ./default_rules.yml
-
 require: rubocop-performance
+
+Performance:
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/BindCall:
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+Performance/Caller:
+  Enabled: true
+Performance/CompareWithBlock:
+  Enabled: true
+Performance/ConcurrentMonotonicTime:
+  Enabled: true
+Performance/ConstantRegexp:
+  Enabled: true
+Performance/DoubleStartEndWith:
+  Enabled: true
+Performance/FlatMap:
+  Enabled: true
+Performance/IoReadlines:
+  Enabled: true
+Performance/MapCompact:
+  Enabled: true
+Performance/RedundantBlockCall:
+  Enabled: true
+Performance/RedundantMatch:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/RegexpMatch:
+  Enabled: true
+Performance/ReverseEach:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SelectMap:
+  Enabled: true
+Performance/Size:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringIdentifierArgument:
+  Enabled: true
+Performance/StringReplacement:
+  Enabled: true
+Performance/UriDefaultParser:
+  Enabled: true

data/rails/db_migrate.yml

@@ -2,15 +2,7 @@ Layout/EmptyLineBetweenDefs:
   Enabled: false
 Layout/LineLength:
   Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
 Style/BlockDelimiters:
   Enabled: false
-Style/Documentation:
-  Enabled: false
 Style/StringLiterals:
   Enabled: false

data/rails/rubocop.yml

@@ -1,22 +1,121 @@
+require: rubocop-rails
+
 inherit_from:
   - ../ruby/rubocop.yml
-  - ./default_rules.yml
-  - ./style.yml
 
-Rails:
-  Enabled: true
-Rails/InverseOf:
-  Enabled: false
-Rails/HasManyOrHasOneDependent:
-  Enabled: false
-Rails/EnvironmentVariableAccess:
-  Enabled: true
-  AllowReads: true
-Rails/ShortI18n:
-  Enabled: false
-Rails/SquishedSQLHeredocs:
-  Enabled: false
-Rails/SkipsModelValidations:
-  Enabled: false
-
-require: rubocop-rails
+Rails/ActiveRecordAliases:
+  Enabled: true
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true
+Rails/ActiveSupportAliases:
+  Enabled: true
+Rails/AddColumnIndex:
+  Enabled: true
+Rails/AfterCommitOverride:
+  Enabled: true
+Rails/ArelStar:
+  Enabled: true
+Rails/AttributeDefaultBlockValue:
+  Enabled: true
+Rails/BelongsTo:
+  Enabled: true
+Rails/ContentTag:
+  Enabled: true
+Rails/Date:
+  Enabled: true
+Rails/Delegate:
+  Enabled: true
+Rails/DelegateAllowBlank:
+  Enabled: true
+Rails/DotSeparatedKeys:
+  Enabled: true
+Rails/DuplicateAssociation:
+  Enabled: true
+Rails/DurationArithmetic:
+  Enabled: true
+Rails/EagerEvaluationLogMessage:
+  Enabled: true
+Rails/EnumHash:
+  Enabled: true
+Rails/EnumUniqueness:
+  Enabled: true
+Rails/EnvironmentComparison:
+  Enabled: true
+Rails/ExpandedDateRange:
+  Enabled: true
+Rails/FindBy:
+  Enabled: true
+Rails/FindById:
+  Enabled: true
+Rails/FindEach:
+  Enabled: true
+Rails/HttpPositionalArguments:
+  Enabled: true
+Rails/HttpStatus:
+  Enabled: true
+Rails/IgnoredSkipActionFilterOption:
+  Enabled: true
+Rails/IndexBy:
+  Enabled: true
+Rails/IndexWith:
+  Enabled: true
+Rails/LexicallyScopedActionFilter:
+  Enabled: true
+Rails/LinkToBlank:
+  Enabled: true
+Rails/MatchRoute:
+  Enabled: true
+Rails/MigrationClassName:
+  Enabled: true
+Rails/Pick:
+  Enabled: true
+Rails/Pluck:
+  Enabled: true
+Rails/PluralizationGrammar:
+  Enabled: true
+Rails/Presence:
+  Enabled: true
+Rails/Present:
+  Enabled: true
+Rails/ReadWriteAttribute:
+  Enabled: true
+Rails/RedundantAllowNil:
+  Enabled: true
+Rails/RedundantForeignKey:
+  Enabled: true
+Rails/RedundantReceiverInWithOptions:
+  Enabled: true
+Rails/RedundantTravelBack:
+  Enabled: true
+Rails/RenderInline:
+  Enabled: true
+Rails/RenderPlainText:
+  Enabled: true
+Rails/RequestReferer:
+  Enabled: true
+Rails/RootJoinChain:
+  Enabled: true
+Rails/RootPublicPath:
+  Enabled: true
+Rails/SafeNavigation:
+  Enabled: true
+Rails/ScopeArgs:
+  Enabled: true
+Rails/StripHeredoc:
+  Enabled: true
+Rails/TimeZone:
+  Enabled: true
+Rails/TimeZoneAssignment:
+  Enabled: true
+Rails/TransactionExitStatement:
+  Enabled: true
+Rails/UniqBeforePluck:
+  Enabled: true
+Rails/UnknownEnv:
+  Enabled: true
+Rails/UnusedIgnoredColumns:
+  Enabled: true
+Rails/Validation:
+  Enabled: true
+Rails/WhereNot:
+  Enabled: true

data/rspec/rubocop.yml

@@ -9,30 +9,103 @@ Layout/SpaceInsideHashLiteralBraces:
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-RSpec/ContextWording:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
-RSpec/MultipleMemoizedHelpers:
-  Max: 10
+
+RSpec/Capybara/CurrentPathExpectation:
+  Enabled: true
+
+RSpec/FactoryBot/AttributeDefinedStatically:
+  Enabled: true
+RSpec/FactoryBot/CreateList:
+  Enabled: true
+RSpec/FactoryBot/FactoryClassName:
+  Enabled: true
+
+RSpec/BeEql:
+  Enabled: true
+RSpec/ContextMethod:
+  Enabled: true
+RSpec/EmptyHook:
+  Enabled: true
+RSpec/EmptyLineAfterExample:
+  Enabled: true
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: true
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: true
+RSpec/EmptyLineAfterHook:
+  Enabled: true
+RSpec/EmptyLineAfterSubject:
+  Enabled: true
+RSpec/ExpectActual:
+  Enabled: true
+RSpec/ExpectInHook:
+  Enabled: true
+RSpec/ExpectOutput:
+  Enabled: true
+RSpec/FilePath:
+  Enabled: true
+RSpec/Focus:
+  Enabled: true
+  AutoCorrect: false
+RSpec/HookArgument:
+  Enabled: true
+RSpec/HooksBeforeExamples:
+  Enabled: true
+RSpec/IdenticalEqualityAssertion:
+  Enabled: true
+RSpec/ImplicitExpect:
+  Enabled: true
+RSpec/ImplicitSubject:
+  Enabled: true
+RSpec/InstanceSpy:
+  Enabled: true
+RSpec/InstanceVariable:
+  Enabled: true
+RSpec/ItBehavesLike:
+  Enabled: true
+RSpec/LeadingSubject:
+  Enabled: true
+RSpec/MultipleSubjects:
+  Enabled: true
 RSpec/NotToNot:
+  Enabled: true
   EnforcedStyle: to_not
-RSpec/NestedGroups:
-  Enabled: false
-RSpec/DescribeClass:
-  Enabled: false
+RSpec/OverwritingSetup:
+  Enabled: true
+RSpec/ReceiveCounts:
+  Enabled: true
+RSpec/ReceiveNever:
+  Enabled: true
+RSpec/RepeatedDescription:
+  Enabled: true
+RSpec/RepeatedExample:
+  Enabled: true
+RSpec/RepeatedExampleGroupBody:
+  Enabled: true
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: true
+RSpec/RepeatedIncludeExample:
+  Enabled: true
+RSpec/ReturnFromStub:
+  Enabled: true
+RSpec/ScatteredLet:
+  Enabled: true
+RSpec/SharedContext:
+  Enabled: true
+RSpec/SharedExamples:
+  Enabled: true
+RSpec/SingleArgumentMessageChain:
+  Enabled: true
+RSpec/UnspecifiedException:
+  Enabled: true
+RSpec/VariableDefinition:
+  Enabled: true
+RSpec/VariableName:
+  Enabled: true
+RSpec/VoidExpect:
+  Enabled: true
+RSpec/Yield:
+  Enabled: true
+
 Style/BlockDelimiters:
   Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/SymbolProc:
-  Exclude:
-    - spec/factories/**/*.rb
-Style/WordArray:
-  Enabled: false

data/ruby/configuration.yml

@@ -3,20 +3,19 @@ AllCops:
   DisplayStyleGuide: true
   ExtraDetails: true
   UseCache: true
-  NewCops: enable
+  NewCops: disable
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
 
   Exclude:
     - bin/**/*
-    - vendor/**/*
+    - config/**/*
+    - config.ru
+    - db/*schema.rb
     - Guardfile
     - lib/tasks/cucumber.rake
     - node_modules/**/*
+    - Rakefile
     - tmp/**/*
-    - db/*schema.rb
-    - config.ru
-    - config/environments/**/*
-    - config/puma.rb
-    - config/spring.rb
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
+    - vendor/**/*