house_style 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e89eeef30906b50d5dc325d748bce8436e48f1b
-  data.tar.gz: 780a58df585ef133efbc1664c651ad2ed7a64931
+SHA256:
+  metadata.gz: 6e14babccb0eeebb8d0d558a49472836dccee7364425f81474e49ce7f8b219a7
+  data.tar.gz: 715dd28aded88cccb79af7144086533a1ba616de99f2c06db3f7e9dbc1905281
 SHA512:
-  metadata.gz: bd9087b18e0228f5b0b9893e4560a9d82e91199b0f0bce76b431e34da39356ec3d6b68817385cb8b8238c473d7564ad8b485ed2de67d65574b0620fd59aed7c8
-  data.tar.gz: 94266ca0dbf7698e336edc0fc8c7c9b0379f53efddc6248d123260679747fb2bbc5077b17a2eee4501d836d60e153c6c5a16da4febd29a7bdda7303bcda40ca2
+  metadata.gz: 0f6c9b7406989e259d9ee3a6e5d6c1ed1022e2ff3dbf58045aac74ced8d3e62f08e198fc70227beee5c1f9874da03191bdb9963b99cf682d19b1008b077b3ae6
+  data.tar.gz: 1ff1cea9a8d4db282e7abd27654bd25f45604c7348b52577b82f4d96a01a0d0129ada77cd31cf4c5fe901f49e4f228296e1346971153fccad7c551abc3d04037

data/.rubocop.yml

@@ -3,7 +3,3 @@
 # See the [README](README.md) for instructions on using `house_style`
 # style settings from within your own projects
 inherit_from: ruby/rubocop.yml
-
-Style/IndentHeredoc:
-  Exclude:
-    - house_style.gemspec

data/.travis.yml

@@ -1,4 +1,7 @@
-language: ruby
+language:
+cache: bundler
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.6
+  - 2.7
+  - 3.0
+before_install: gem install bundler -v 2.2.18

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # CHANGELOG
 
+## 2.0.0
+### New features
+
+- Add new rubocop extensions: rubocop-performance & rubocop-rake. Both enabled by default on Ruby configuration.
+
+### Bug fixes
+
+- Restrict extensions versions to avoid introducing new cops in the apps depending on house_style without previously configuing them here.
+- Exclude most Rails default configuration files for our cops to decrease the number of conflicts during Rails upgrades.
+
+### Changes
+
+- Update Travis CI configuration and add a default Rake task (rubocop)
+- Upgrade development dependencies: Bundler & Rake.
+- Upgrade rubocop to 1.15.0, rubocop-rails to 2.10.1 and rubocop-rspec to 2.3.0.
+- Remove old pre-1.0 post-install message.
+
+## 1.6.0
+- [FIX] Require Rubocop higher than 0.49 to fix security issue: https://nvd.nist.gov/vuln/detail/CVE-2017-8418
+- [FIX] Rename `IndentHash` to `IndentFirstHashElement`, and require Rubocop 0.68 or higher because of this change.
+- Rails cops are now split into a different gem `rubocop-rails` that we include by default.
+- Disable new Rails cops InverseOf & HasManyOrHasOneDependent.
+- Exclude spec files for Lint/AmbiguousBlockAssociation as recommended in https://github.com/rubocop-hq/rubocop/issues/4222#issuecomment-290655562
+- Exclude specific rake configuration file for RSpec/ContextWording.
+- Specify `indented` as the default value for `IndentFirstArrayElement`.
+- Enforce `single_quotes` for `StringLiterals` by default.
+
+
+## 1.5.1
+- [FIX] Remove `Include` values. Since 0.57 `Include` overwrites the hardcoded defaults. All values here are already included in the defaults, so no point in defining them here anymore.
+- [FIX] `SpaceInsideHashLiteralBraces` now belongs to `Layout` instead of `Style`
+- [FIX] Disabling new added cop `Style/AccessModifierDeclarations`. We use inline declarations (`private :foo :bar`) as default in our codebase.
+
+## 1.5.0
+- updated rubocop to 0.63.1
+
+## 1.4.0
+
+- updated rubocop to 0.52.0
+  - rename cops with changed names and remove deprecated definitions.
+
 ## 1.3.0
 
 - updated rubocop to 0.46.0

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+desc 'Run rubocop'
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+task default: :rubocop

data/house_style.gemspec

@@ -1,32 +1,26 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'house_style'
-  spec.version       = '1.3.1'
-  spec.authors       = ['Scott Matthewman']
-  spec.email         = ['scott@altmetric.com']
+  spec.version       = '2.0.0'
+  spec.authors       = ['Altmetric', 'Scott Matthewman']
+  spec.email         = ['engineering@altmetric.com', 'scott.matthewman@gmail.com']
 
   spec.summary       = 'A centralised store of house style rules'
   spec.description   = 'Configuration files and other snippets to help you apply standards across multiple projects'
   spec.homepage      = 'https://github.com/altmetric/house_style'
   spec.license       = 'MIT'
 
-  spec.post_install_message = <<-ENDOFMESSAGE
-If you are updating house_style from version 1.0.0 or older, note that you can
-now remove any reference to TargetRubyVersion in your project's .rubocop.yml
-file. You should specify a .ruby-version file for your entire project, and that
-will be taken into account by rubocop also.
-  ENDOFMESSAGE
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.48', '< 0.49'
-  spec.add_dependency 'rubocop-rspec', '~> 1.15'
+  spec.add_dependency 'rubocop', '>= 1.0', '< 1.16'
+  spec.add_dependency 'rubocop-performance', '~> 1.11.3'
+  spec.add_dependency 'rubocop-rails', '~> 2.10.1'
+  spec.add_dependency 'rubocop-rake', '< 1.0'
+  spec.add_dependency 'rubocop-rspec', '~> 2.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/performance/default_rules.yml

@@ -0,0 +1,32 @@
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+Performance/ConstantRegexp:
+  Enabled: true
+Performance/MapCompact:
+  Enabled: true
+Performance/MethodObjectAsBlock:
+  Enabled: true
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+Performance/Sum:
+  Enabled: true

data/performance/rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from:
+  - ./default_rules.yml
+
+require: rubocop-performance

data/rails/db_migrate.yml

@@ -1,6 +1,10 @@
-Metrics/ClassLength:
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/AbcSize:
   Enabled: false
-Metrics/LineLength:
+Metrics/ClassLength:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
@@ -8,9 +12,5 @@ Style/BlockDelimiters:
   Enabled: false
 Style/Documentation:
   Enabled: false
-Style/EmptyLineBetweenDefs:
-  Enabled: false
 Style/StringLiterals:
   Enabled: false
-Metrics/AbcSize:
-  Enabled: false

data/rails/default_rules.yml

@@ -0,0 +1,34 @@
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true
+Rails/AfterCommitOverride:
+  Enabled: true
+Rails/AttributeDefaultBlockValue:
+  Enabled: true
+Rails/FindById:
+  Enabled: true
+Rails/Inquiry:
+  Enabled: true
+Rails/MailerName:
+  Enabled: true
+Rails/MatchRoute:
+  Enabled: true
+Rails/NegateInclude:
+  Enabled: true
+Rails/Pluck:
+  Enabled: true
+Rails/PluckInWhere:
+  Enabled: true
+Rails/RenderInline:
+  Enabled: true
+Rails/RenderPlainText:
+  Enabled: true
+Rails/SquishedSQLHeredocs:
+  Enabled: true
+Rails/TimeZoneAssignment:
+  Enabled: true
+Rails/WhereEquals:
+  Enabled: true
+Rails/WhereExists:
+  Enabled: true
+Rails/WhereNot:
+  Enabled: true

data/rails/rubocop.yml

@@ -1,4 +1,8 @@
-inherit_from: ../ruby/rubocop.yml
+inherit_from:
+  - ../ruby/rubocop.yml
+  - ./default_rules.yml
+  - ./style.yml
+
 AllCops:
   Exclude:
     - bin/**/*
@@ -7,3 +11,14 @@ AllCops:
     - lib/tasks/cucumber.rake
 Rails:
   Enabled: true
+Rails/InverseOf:
+  Enabled: false
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+Rails/EnvironmentVariableAccess:
+  Enabled: true
+  AllowReads: true
+Rails/ShortI18n:
+  Enabled: false
+
+require: rubocop-rails

data/rails/style.yml

@@ -0,0 +1,31 @@
+# Exclude Rails default configuration files that offend our cops to avoid
+# conflicts during Rails upgrades
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - config/environments/production.rb
+
+Rails/FilePath:
+  Exclude:
+    - config/environments/development.rb
+
+Style/GlobalStdStream:
+  Exclude:
+    - config/environments/production.rb
+
+Style/StringLiterals:
+  Exclude:
+    - config/application.rb
+    - config/boot.rb
+    - config/environment.rb
+    - config/environments/development.rb
+    - config/environments/production.rb
+    - config/environments/test.rb
+    - config/initializers/**
+    - config/puma.rb
+    - config.ru
+    - Rakefile
+
+Style/SymbolArray:
+  Exclude:
+    - config/initializers/filter_parameter_logging.rb
+

data/rake/rubocop.yml

@@ -0,0 +1 @@
+require: rubocop-rake

data/rspec/rubocop.yml

@@ -2,12 +2,20 @@ inherit_from: ../ruby/rubocop.yml
 
 require: rubocop-rspec
 
-Metrics/BlockLength:
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
-Metrics/LineLength:
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+Metrics/BlockLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+RSpec/ContextWording:
+  Exclude:
+    - spec/support/shared_contexts/rake.rb
 RSpec/ExampleLength:
   Enabled: false
 RSpec/NotToNot:
@@ -17,8 +25,6 @@ Style/BlockDelimiters:
     - spec/factories/**/*.rb
 Style/Documentation:
   Enabled: false
-Style/SpaceInsideHashLiteralBraces:
-  Enabled: false
 Style/SymbolProc:
   Exclude:
     - spec/factories/**/*.rb

data/ruby/configuration.yml

@@ -4,23 +4,9 @@ AllCops:
   ExtraDetails: true
   UseCache: true
 
-  Include:
-    - '**/*.gemspec'
-    - '**/*.podspec'
-    - '**/*.jbuilder'
-    - '**/*.rake'
-    - '**/*.opal'
-    - '**/config.ru'
-    - '**/Gemfile'
-    - '**/Rakefile'
-    - '**/Capfile'
-    - '**/Guardfile'
-    - '**/Podfile'
-    - '**/Thorfile'
-    - '**/Vagrantfile'
-    - '**/Berksfile'
-    - '**/Cheffile'
-    - '**/Vagabondfile'
   Exclude:
     - 'vendor/**/*'
     - 'bin/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/ruby/default_rules.yml

@@ -0,0 +1,60 @@
+Gemspec/DateAssignment:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/ruby/metrics.yml

@@ -1,11 +1,2 @@
-Metrics/LineLength:
-  Max: 120
-  Details: >-
-    If lines are too short, methods become hard to read because you must
-    constantly jump from line to line. If lines are too long, following
-    the flow can be hard because it becomes harder to scan back and
-    locate the start of the next line. 80 characters is generally a bit
-    too short; 120 characters is a good compromise.
 Metrics/MethodLength:
   Max: 10
-

data/ruby/rubocop.yml

@@ -2,3 +2,6 @@ inherit_from:
   - ./configuration.yml
   - ./metrics.yml
   - ./style.yml
+  - ./default_rules.yml
+  - ../rake/rubocop.yml
+  - ../performance/rubocop.yml

data/ruby/style.yml

@@ -1,3 +1,23 @@
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/MultilineOperationIndentation:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/LineLength:
+  Max: 120
+  Details: >-
+    If lines are too short, methods become hard to read because you must
+    constantly jump from line to line. If lines are too long, following
+    the flow can be hard because it becomes harder to scan back and
+    locate the start of the next line. 80 characters is generally a bit
+    too short; 120 characters is a good compromise.
+Style/AccessModifierDeclarations:
+  Enabled: false
 Style/BlockDelimiters:
   EnforcedStyle: semantic
   FunctionalMethods:
@@ -17,12 +37,6 @@ Style/BlockDelimiters:
     - let!
     - subject
     - watch
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-  Details: >-
-    When the last (or only) argument to a method is a Hash,
-    omit the { } braces. The exception is if the preceding
-    argument is also a Hash.
 Style/CollectionMethods:
   Enabled: true
 Style/CommandLiteral:
@@ -31,24 +45,14 @@ Style/Copyright:
   Enabled: false
 Style/Documentation:
   Enabled: false
-Style/EmptyLineBetweenDefs:
-  AllowAdjacentOneLineDefs: true
-Style/Encoding:
-  EnforcedStyle: when_needed
 Style/FrozenStringLiteralComment:
   Enabled: false
 Style/GuardClause:
   MinBodyLength: 3
 Style/HashSyntax:
   EnforcedStyle: ruby19_no_mixed_keys
-Style/IfUnlessModifier:
-  MaxLineLength: 100
-Style/IndentHash:
-  EnforcedStyle: consistent
 Style/MethodCalledOnDoEndBlock:
   Enabled: true
-Style/MultilineOperationIndentation:
-  Enabled: false
 Style/NonNilCheck:
   IncludeSemanticChanges: true
 Style/NumericLiterals:
@@ -56,6 +60,7 @@ Style/NumericLiterals:
 Style/SignalException:
   EnforcedStyle: semantic
 Style/StringLiterals:
-  Enabled: false
+  EnforcedStyle: 'single_quotes'
+  Enabled: true
 Style/StringMethods:
   Enabled: true

metadata

@@ -1,81 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: house_style
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
+- Altmetric
 - Scott Matthewman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: 1.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
 description: Configuration files and other snippets to help you apply standards across
   multiple projects
 email:
-- scott@altmetric.com
+- engineering@altmetric.com
+- scott.matthewman@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -98,10 +142,16 @@ files:
 - lib/generators/house_style/templates/db_migrate_rubocop.yml
 - lib/generators/house_style/templates/rspec-rubocop.yml
 - lib/generators/house_style/templates/rubocop.yml
+- performance/default_rules.yml
+- performance/rubocop.yml
 - rails/db_migrate.yml
+- rails/default_rules.yml
 - rails/rubocop.yml
+- rails/style.yml
+- rake/rubocop.yml
 - rspec/rubocop.yml
 - ruby/configuration.yml
+- ruby/default_rules.yml
 - ruby/metrics.yml
 - ruby/rubocop.yml
 - ruby/style.yml
@@ -109,11 +159,7 @@ homepage: https://github.com/altmetric/house_style
 licenses:
 - MIT
 metadata: {}
-post_install_message: |
-  If you are updating house_style from version 1.0.0 or older, note that you can
-  now remove any reference to TargetRubyVersion in your project's .rubocop.yml
-  file. You should specify a .ruby-version file for your entire project, and that
-  will be taken into account by rubocop also.
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,9 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A centralised store of house style rules
 test_files: []