house_style 2.2.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce8222443b062e50feeb386f3d441f0f5e549bf2f461f457c27714f0cc0dad96
-  data.tar.gz: 6157b1653324717cdf7dc1edeca3a089d940ee701096657e66a1a35f3e7bde65
+  metadata.gz: 0c947968f6d0fc33d002800803ef43964505d6612eb4ae0b5b77b22f69930c8e
+  data.tar.gz: 0f2ffa40cba2c8c601918a1293860df3b4057193a91660c7bf53adffd15f1b02
 SHA512:
-  metadata.gz: 79765f7756680a6fbdf8983dad1855e8768ab2be58045111d9b31ed16f69b2285f61f1744325d26069bc2c55d814ab0031dc8bf9bb97a034c1568dc1a077689c
-  data.tar.gz: c7cd1db842e928fb54547daabb34f64544b20eb7f22cad1b5de43429b737d2cd511998b2d1c3ee5d0397bd328a43901caa9d32d74811324dde1644685d780321
+  metadata.gz: e630442c72620678ede86e122641eb7bf77a7d68d5bac6af010b3715b37570414350efb177c22603b9e8ceff70f2de05d2d9019b5bd88820f069509dfdc3e7c8
+  data.tar.gz: d3929cb712e7fcdf91937c0281bfbd3dc1eb54ce0730983a01c48ee96b1797a31102b628a5d0dc9e96b903ea8383dcba8b70041ded132f04a0d476eeccffe109

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # CHANGELOG
 
-## CURRENT
+## 3.1.0
+### Changes
+- Do not suggest extensions
+- Remove Rails/FindById (it isn't safe if you're using MongoId in a project depending on your configuration)
+- Use `braces_for_chaining` for `Style/BlockDelimiters`. As a team, we've agreed to use this more general extended approach among the community. It also simplifies configuration for specs, fixtures, migrations... etc.
+## Bug fixes
+- In RSpec template, do not inherit the root configuration, as the rspec .rubocop.yml file already inherits the ruby configuration itself.
+
+## 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
+- Exclude more Rails configuration files affected by rails app:update.
 
 ## 2.2.1
 ### Bug fixes

data/features/rubocop.yml

@@ -2,14 +2,3 @@ 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.2.1'
+  spec.version       = '3.1.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,2 @@
-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,5 @@ 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,119 @@
+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/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,100 @@ 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
-Style/BlockDelimiters:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/SymbolProc:
-  Exclude:
-    - spec/factories/**/*.rb
-Style/WordArray:
-  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

data/ruby/configuration.yml

@@ -3,17 +3,20 @@ 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
+  SuggestExtensions: false
 
   Exclude:
     - bin/**/*
-    - vendor/**/*
+    - config/**/*
+    - config.ru
+    - db/*schema.rb
     - Guardfile
     - lib/tasks/cucumber.rake
     - node_modules/**/*
+    - Rakefile
     - tmp/**/*
-    - db/*schema.rb
-    - config.ru
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
+    - vendor/**/*