gitlab-styles 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 410e573c3c17d84349a00ff756141e55ece0ba68c0d9aa23b76cfe2a8abde3ae
-  data.tar.gz: a2fb908127f5f31c8d4a235155b4b2ad3208802cfc01bf895321a522a270477b
+  metadata.gz: 2e3e06ef1557da413f41116af9b5b01733a309e35bcd2717e8d8ec2473470589
+  data.tar.gz: 704feb3fc08d96cde2a0cdadc8dbe5bbdde1bcb3b18a010f6b964462ec0f33aa
 SHA512:
-  metadata.gz: aa3f38ac00b776237c2a497ebb76d36e1ad51addc814ecbba7370a4d4cbeb0f67777131494a825431a2aa592d6597e57eaa83cae86ec452955b0399e1e46e1ec
-  data.tar.gz: 445dfab1d9c2f0874c1c7ddb65426bf32953515fcfe1e96b15a119914acc5258753182318b524ff2d8af86b0fb1769d09f0991ce1aa8d2d24cd2a22cfcbe62fb
+  metadata.gz: 1dcbe74347c735155eed09bfd24923dff24013454269d8edc7d5e62c4b35ebf7413958bd3b4cff55192bdc51f01dbdfdf438f853dfab322e20b96f6ed283142c
+  data.tar.gz: 74ce09358878dd2deca30b2af8698eb46f3417b9f041794c00ee5e97bda90719548fb86250ef8718a7969c23361d256e7acf5669abaaaf6d60ed23eb5608e516

data/.gitlab-ci.yml

@@ -3,7 +3,7 @@ stages:
   - deploy
 
 default:
-  image: ruby:2.7
+  image: "ruby:${RUBY_VERSION}"
   tags:
     - gitlab-org
   before_script:
@@ -23,11 +23,17 @@ styles:
   stage: test
   script:
     - bundle exec rubocop --debug --parallel
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
 
 specs:
   stage: test
   script:
     - bundle exec rspec
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
 
 include:
   - project: 'gitlab-org/quality/pipeline-common'

data/Gemfile

@@ -5,9 +5,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gitlab-rubocop.gemspec
 gemspec
 
+group :development do
+  gem "lefthook", require: false
+end
+
 group :test do
   # Pin these dependencies, otherwise a new rule could break the CI pipelines
-  gem 'rubocop', '1.36.0'
-  gem 'rubocop-rspec', '2.12.1'
+  gem 'rubocop', '1.38.0'
+  gem 'rubocop-rspec', '2.15.0'
   gem 'rspec-parameterized', '0.5.2', require: false
 end

data/README.md

@@ -66,10 +66,35 @@ After checking out the repo, run `bin/setup` to install dependencies.
 Then, run `rake spec` to run the tests. You can also run `bin/console` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To test some rules locally, there is a test application [in the playground folder](./playground/). It is a vanilla Rails 6 application with your local `gitlab-styles` included, and it is used to test RuboCop rules. You can add code in it (preferably RuboCop offenses) and run the following command to test the RuboCop policy we setup:
+
+```shell
+cd playground
+bundle install
+bundle exec rubocop -c .rubocop.yml
+```
+
+### Activate lefthook locally
+
+```shell
+lefthook install
+```
+
+## Release Process
+
+We release `gitlab-styles` on an ad-hoc basis. There is no regularity to when
+we release, we just release when we make a change - no matter the size of the
+change.
+
+To release a new version:
+
+1. Create a Merge Request.
+1. Use Merge Request template [Release.md](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/blob/master/.gitlab/merge_request_templates/Release.md).
+1. Follow the instructions.
+1. (Optional, but appreciated) Create an MR on `gitlab-org/gitlab` project [with the `New Version of gitlab-styles.md` template](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/New%20Version%20of%20gitlab-styles.md) to test the new version of `gitlab-styles`, and follow the MR instructions.
+1. After the Merge Request has been merged, a new gem version is [published automatically](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/gem-release.yml)
+
+See [!123](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/123) as an example.
 
 ## Contributing
 
@@ -78,10 +103,6 @@ https://gitlab.com/gitlab-org/gitlab-styles. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## Release Process
-
-Please refer to the [Release Process](docs/release_process.md).
-
 ## License
 
 The gem is available as open source under the terms of the

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "gitlab/styles"

data/gitlab-styles.gemspec

@@ -16,18 +16,18 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(docs|test|spec|features)/})
+    f.match(%r{^(docs|test|spec|features|playground)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 1.36.0'
+  spec.add_dependency 'rubocop', '~> 1.38.0'
   spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.1'
   spec.add_dependency 'rubocop-graphql', '~> 0.14'
   spec.add_dependency 'rubocop-performance', '~> 1.14'
   spec.add_dependency 'rubocop-rails', '~> 2.15'
-  spec.add_dependency 'rubocop-rspec', '~> 2.12'
+  spec.add_dependency 'rubocop-rspec', '~> 2.15'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.11.0'

data/lefthook.yml

@@ -0,0 +1,16 @@
+# Lefthook configuration. For more information, see:
+# https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
+
+pre-push:
+  parallel: true
+  commands:
+    # Run ruby linting
+    rubocop:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.{rb,rake}'
+      run: bundle exec rubocop --parallel --force-exclusion {files}
+
+    # Run all tests (warn if there are any missing tools required for tests).
+    rspec:
+      run: bundle exec rspec -f progress
+      glob: '*.rb'

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '9.0.0'
+    VERSION = '9.2.0'
   end
 end

data/lib/rubocop/cop/gem_fetcher.rb

@@ -6,31 +6,29 @@ module Rubocop
     # `Gemfile` in order to avoid additional points of failure beyond
     # rubygems.org.
     class GemFetcher < RuboCop::Cop::Base
-      MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'
+      MSG = 'Do not use gems from git repositories, only use gems from RubyGems or vendored gems. ' \
+            'See https://docs.gitlab.com/ee/development/gemfile.html#no-gems-fetched-from-git-repositories'
 
-      GIT_KEYS = [:git, :github].freeze
+      # See https://bundler.io/guides/git.html#custom-git-sources
+      GIT_SOURCES = %i[git github gist bitbucket].freeze
 
-      def on_send(node)
-        return unless gemfile?(node)
-
-        func_name = node.children[1]
-        return unless func_name == :gem
+      # @!method gem_option(node)
+      def_node_matcher :gem_option, <<~PATTERN
+        (send nil? :gem _
+          (hash
+            <$(pair (sym {#{GIT_SOURCES.map(&:inspect).join(' ')}}) _)
+            ...>
+          )
+        )
+      PATTERN
 
-        node.children.last.each_node(:pair) do |pair|
-          key_name = pair.children[0].children[0].to_sym
-          add_offense(pair.source_range) if GIT_KEYS.include?(key_name)
-        end
-      end
+      RESTRICT_ON_SEND = %i[gem].freeze
 
-      private
+      def on_send(node)
+        pair_node = gem_option(node)
+        return unless pair_node
 
-      def gemfile?(node)
-        node
-          .location
-          .expression
-          .source_buffer
-          .name
-          .end_with?("Gemfile")
+        add_offense(pair_node)
       end
     end
   end

data/lib/rubocop/cop/line_break_around_conditional_block.rb

@@ -70,6 +70,7 @@ module Rubocop
       def previous_line_valid?(node)
         previous_line(node).empty? ||
           start_clause_line?(previous_line(node)) ||
+          method_def_end?(node.parent, previous_line(node)) ||
           block_start?(previous_line(node)) ||
           begin_line?(previous_line(node)) ||
           assignment_line?(previous_line(node)) ||
@@ -94,6 +95,10 @@ module Rubocop
         line =~ /^\s*(def|=end|#|module|class|if|unless|else|elsif|ensure|when)/
       end
 
+      def method_def_end?(node, line)
+        node.def_type? && /\)\s*(#.*)?$/.match?(line)
+      end
+
       def end_clause_line?(line)
         line =~ /^\s*(#|rescue|else|elsif|when)/
       end

data/lib/rubocop/cop/rspec/empty_line_after_shared_example.rb

@@ -45,7 +45,7 @@ module Rubocop
 
         # @!method shared_examples(node)
         def_node_matcher :shared_examples,
-                         block_pattern('{#SharedGroups.all #Includes.all}')
+          block_pattern('{#SharedGroups.all #Includes.all}')
 
         def on_block(node)
           shared_examples(node) do

data/rubocop-bundler.yml

@@ -1,4 +1,14 @@
 ---
+require:
+  - ./lib/rubocop/cop/gem_fetcher
+
 # Gems in consecutive lines should be alphabetically sorted
 Bundler/OrderedGems:
   Enabled: false
+
+Cop/GemFetcher:
+  Enabled: true
+  Include:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'

data/rubocop-layout.yml

@@ -3,9 +3,15 @@
 Layout/AccessModifierIndentation:
   Enabled: true
 
+# Check if the arguments on a multi-line method definition are aligned.
+Layout/ArgumentAlignment:
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: with_fixed_indentation
+
 # Align the elements of an array literal if they span more than one line.
 Layout/ArrayAlignment:
-  Enabled: true
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: with_fixed_indentation
 
 # Checks the indentation of the first line of the right-hand-side of a
 # multi-line assignment.
@@ -102,6 +108,23 @@ Layout/EndOfLine:
 Layout/ExtraSpacing:
   Enabled: true
 
+# Checks the indentation of the first argument in a method call.
+Layout/FirstArgumentIndentation:
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: consistent
+
+# Checks the indentation of the first element in an array literal where the
+# opening bracket and the first element are on separate lines.
+Layout/FirstArrayElementIndentation:
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: consistent
+
+# Checks the indentation of the first key in a hash literal where the opening
+# brace and the first key are on separate lines.
+Layout/FirstHashElementIndentation:
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: consistent
+
 # Checks for a line break before the first parameter in a multi-line method
 # parameter definition.
 Layout/FirstMethodParameterLineBreak:
@@ -137,6 +160,17 @@ Layout/LineLength:
   Max: 120
   AllowedPatterns: ['\s#\srubocop']
 
+# Checks that strings broken over multiple lines (by a backslash) contain
+# trailing spaces instead of leading spaces (default) or leading spaces instead
+# of trailing spaces.
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+
+# Checks that the backslash of a line continuation is separated from preceding
+# text by exactly one space (default) or zero spaces.
+Layout/LineContinuationSpacing:
+  Enabled: true
+
 # Checks that the closing brace in an array literal is either on the same line
 # as the last array element, or a new line.
 Layout/MultilineArrayBraceLayout:
@@ -147,6 +181,11 @@ Layout/MultilineArrayBraceLayout:
 Layout/MultilineBlockLayout:
   Enabled: true
 
+# Checks the indentation of the next line after a line that ends with a string
+# literal and a backslash.
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
 # Checks that the closing brace in a hash literal is either on the same line as
 # the last hash element, or a new line.
 Layout/MultilineHashBraceLayout:
@@ -177,7 +216,8 @@ Layout/MultilineOperationIndentation:
 # Here we check if the parameters on a multi-line method call or
 # definition are aligned.
 Layout/ParameterAlignment:
-  Enabled: false
+  # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/42
+  EnforcedStyle: with_fixed_indentation
 
 # Use spaces after colons.
 Layout/SpaceAfterColon:
@@ -223,6 +263,10 @@ Layout/SpaceAroundOperators:
 Layout/SpaceBeforeBlockBraces:
   Enabled: true
 
+# Checks for space between the name of a receiver and a left brackets.
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
 # No spaces before commas.
 Layout/SpaceBeforeComma:
   Enabled: true

data/rubocop-lint.yml

@@ -12,7 +12,7 @@ Lint/AmbiguousOperator:
 # This cop checks for ambiguous regexp literals in the first argument of
 # a method invocation without parentheses.
 Lint/AmbiguousRegexpLiteral:
-  Enabled: false
+  Enabled: true
 
 # This cop checks for assignments in the conditions of
 # if/while/until.

data/rubocop-performance.yml

@@ -28,6 +28,11 @@ Performance/Casecmp:
 Performance/CollectionLiteralInLoop: # (new in 1.8)
   Enabled: true
 
+# Identifies places where Concurrent.monotonic_time can be replaced by
+# Process.clock_gettime(Process::CLOCK_MONOTONIC).
+Performance/ConcurrentMonotonicTime:
+  Enabled: true
+
 Performance/ConstantRegexp: # (new in 1.9)
   Enabled: true
 
@@ -36,6 +41,17 @@ Performance/ConstantRegexp: # (new in 1.9)
 Performance/DoubleStartEndWith:
   Enabled: true
 
+# Identifies usages of map { ... }.flatten and change them to use
+# flat_map { ... } instead.
+Performance/FlatMap:
+  Enabled: true
+  EnabledForFlattenWithoutParams: true
+
+# This cop identifies places where map { …​ }.compact can be replaced by
+# filter_map.
+Performance/MapCompact:
+  Enabled: true
+
 Performance/MethodObjectAsBlock: # (new in 1.9)
   Enabled: true
 
@@ -52,6 +68,11 @@ Performance/RangeInclude:
 Performance/RedundantBlockCall:
   Enabled: true
 
+# Checks for uses Enumerable#all?, Enumerable#any?, Enumerable#one?, and
+# Enumerable#none? are compared with === or similar methods in block.
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+
 # This cop identifies use of `Regexp#match` or `String#match in a context
 # where the integral return value of `=~` would do just as well.
 Performance/RedundantMatch:
@@ -73,6 +94,11 @@ Performance/RedundantSortBlock:
 Performance/RedundantStringChars:
   Enabled: true
 
+# Identifies places where split argument can be replaced from a deterministic
+# regexp to a string.
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+
 # Identifies places where reverse.first(n) and reverse.first can be replaced by last(n).reverse and last.
 # https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancereversefirst
 Performance/ReverseFirst:
@@ -98,6 +124,12 @@ Performance/StartWith:
 Performance/StringInclude:
   Enabled: true
 
+# Identifies places where string identifier argument can be replaced by symbol
+# identifier argument. It prevents the redundancy of the internal
+# string-to-symbol conversion.
+Performance/StringIdentifierArgument:
+  Enabled: true
+
 # Use `tr` instead of `gsub` when you are replacing the same number of
 # characters. Use `delete` instead of `gsub` when you are deleting
 # characters.

data/rubocop-rspec.yml

@@ -14,6 +14,16 @@ RSpec/BeEql:
 RSpec/BeforeAfterAll:
   Enabled: false
 
+# Checks if there is a more specific finder offered by Capybara.
+# https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/131#note_1141024624
+RSpec/Capybara/SpecificFinders:
+  Enabled: false
+
+# Enforces consistent use of be_a or be_kind_of.
+# https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/131#note_1141022718
+RSpec/ClassCheck:
+  Enabled: false
+
 # Check that the first argument to the top level describe is the tested class or
 # module.
 RSpec/DescribeClass:
@@ -30,6 +40,7 @@ RSpec/DescribeSymbol:
 # Checks that tests use `described_class`.
 RSpec/DescribedClass:
   Enabled: true
+  SkipBlocks: true
 
 # Checks if an example group does not include any tests.
 RSpec/EmptyExampleGroup:
@@ -61,6 +72,12 @@ RSpec/ExampleWording:
 RSpec/ExpectActual:
   Enabled: true
 
+# Checks for `expect {...}.to change {...}` using a block.
+# See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/122#note_1089192391
+RSpec/ExpectChange:
+  Enabled: true
+  EnforcedStyle: block
+
 # Checks for opportunities to use `expect { … }.to output`.
 RSpec/ExpectOutput:
   Enabled: true
@@ -131,6 +148,10 @@ RSpec/NotToNot:
   EnforcedStyle: not_to
   Enabled: true
 
+# See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/122#note_1089202045
+RSpec/PredicateMatcher:
+  Enabled: false
+
 # Check for repeated description strings in example groups.
 RSpec/RepeatedDescription:
   Enabled: false
@@ -161,9 +182,3 @@ RSpec:
       - let_it_be
       - let_it_be_with_refind
       - let_it_be_with_reload
-    Includes:
-      Examples:
-        - run_permission_checks
-        - run_group_permission_checks
-        - it_should_email!
-        - it_should_not_email!

data/rubocop-security.yml

@@ -11,6 +11,10 @@ Security/JSONLoad:
 Security/Eval:
   Enabled: true
 
+# Checks for the first argument to IO.read, IO.binread, IO.write, IO.binwrite, IO.foreach, and IO.readlines
+Security/IoMethods:
+  Enabled: true
+
 GitlabSecurity/DeepMunge:
   Enabled: true
   Exclude:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.38.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
   name: rubocop-gitlab-security
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - bin/console
 - bin/setup
 - gitlab-styles.gemspec
+- lefthook.yml
 - lib/gitlab/styles.rb
 - lib/gitlab/styles/common/banned_constants.rb
 - lib/gitlab/styles/rubocop.rb