gitlab-styles 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 410e573c3c17d84349a00ff756141e55ece0ba68c0d9aa23b76cfe2a8abde3ae
-  data.tar.gz: a2fb908127f5f31c8d4a235155b4b2ad3208802cfc01bf895321a522a270477b
+  metadata.gz: 50eab9da6dd93cfbda3c8a8877e6ac2f8ce8274d6f92116973e6c9c1ee590d5f
+  data.tar.gz: f7e187d901c89bb4d4ba4a40d72523b10c5148ef965d60b243e8c09c9bc21642
 SHA512:
-  metadata.gz: aa3f38ac00b776237c2a497ebb76d36e1ad51addc814ecbba7370a4d4cbeb0f67777131494a825431a2aa592d6597e57eaa83cae86ec452955b0399e1e46e1ec
-  data.tar.gz: 445dfab1d9c2f0874c1c7ddb65426bf32953515fcfe1e96b15a119914acc5258753182318b524ff2d8af86b0fb1769d09f0991ce1aa8d2d24cd2a22cfcbe62fb
+  metadata.gz: a9d90f34b3a3e6d97c6a791c5f91a26318b956751a77b2827f5370e15f8717bdf30cf30ddad0c63afd1f2335707d76dd948d1c7898c0d762f9b19389dea55d49
+  data.tar.gz: 9634b21fcc052557e12ebd277279089e4cfd325b88860c45a5250da554b0f14e378b7cdf8c9648d019649cd1396b327fc7cf10d48462622f00f1af888cd61b31

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,19 @@ 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
+```
 
 ## Contributing
 
@@ -80,7 +89,18 @@ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Release Process
 
-Please refer to the [Release Process](docs/release_process.md).
+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. A new gem version is [published automatically](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/gem-release.yml) after the Merge Request has been merged.
+
+See [!123](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/123) as an example.
 
 ## License
 

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.1.0'
   end
 end

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:
@@ -61,6 +71,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 +147,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 +181,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.1.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-11-15 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