gitlab-styles 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b678f69301c072f2a4ff3568240a53603af1dde32d22b4bcc7bfde79477fb281
-  data.tar.gz: c5c3462573f631914c3bd10bd84589cec1f3f75c39e40acf11b9fca28c110e50
+  metadata.gz: b5f56cd42de5afd61307ea92fd0114cb64e79b575697800b948e6d3e42e32d7c
+  data.tar.gz: 25c343aae93b4bb8d03d57b92152c5c51433cacec86c86b6449ba8a6af3cc6e2
 SHA512:
-  metadata.gz: 57d30093fc6fbe46cb2039e89c16f68b97dab5d2e794e75f8ab732c8e723887bd1dc3dd3708561d12767055b46820a413a495bf3a1790af4f1caf1f4f128230f
-  data.tar.gz: b58567db3d26db1a13f5c6327484f34cb79bc5914a1a27357b54cbe41e88fb5efbffba56d2605630c66dd91cc4cd9d5078e276cf6425caed7af789fcfd8bfa92
+  metadata.gz: a7e7dbc2a80150595404fb1639266f462687668411b4410378a1021d9d07915fec14d6b34265d2a6672d65e5005cb4e2d7a1e99acff2ddbe0bc827280dc1c011
+  data.tar.gz: c0b9073e17bf0c11f283ef485612746c3baa1a6de27392029ca930413f939cc192d797e0a3a3016da2db0bdc219444c93129199fbba9ab81e533f86182c65d10

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/.gitlab-ci.yml

@@ -1,13 +1,45 @@
-image: ruby:2.3
+stages:
+  - release
+  - test
 
-before_script:
-  - bundle --version
-  - bundle install
+default:
+  image: ruby:2.6
+  tags:
+    - gitlab-org
+  before_script:
+    - bundle --version
+    - bundle install
+
+workflow:
+  rules:
+    # For merge requests, create a pipeline.
+    - if: '$CI_MERGE_REQUEST_IID'
+    # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
+    - if: '$CI_COMMIT_BRANCH == "master"'
+    # For tags, create a pipeline.
+    - if: '$CI_COMMIT_TAG'
 
 styles:
+  stage: test
   script:
     - bundle exec rubocop --debug --parallel
 
 specs:
+  stage: test
   script:
     - bundle exec rspec
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - gem build gitlab-styles.gemspec
+    - gem push gitlab-styles*.gem
+  artifacts:
+    paths:
+      - gitlab-styles*.gem
+    expire_in: 30 days

data/.gitlab/merge_request_templates/Release.md

@@ -0,0 +1,35 @@
+<!-- Replace `v4.5.0` with the previous release here, and `e18d76b309e42888759c1effe96767f13e34ae55`
+with the latest commit from https://gitlab.com/gitlab-org/gitlab-styles/commits/master that will be included in the release. -->
+- Diff: https://gitlab.com/gitlab-org/gitlab-styles/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
+
+- Release notes:
+
+<!-- Keep the sections order but remove the empty sections -->
+
+```markdown
+### New scenarios and scenario updates
+
+- !aaa <Title of the aaa MR>.
+
+### Fixes
+
+- !bbb <Title of the bbb MR>.
+
+### Doc changes
+
+- !ccc <Title of the ccc MR>.
+
+### Other changes (CI, backstage)
+
+- !ddd <Title of the ddd MR>.
+```
+
+- Checklist before merging:
+  - [ ] Diff link is up-to-date.
+  - [ ] Based on the diff, `lib/gitlab/styles/version.rb` is updated, according to [SemVer](https://semver.org).
+  - [ ] Release notes are accurate.
+
+- Checklist after merging:
+  - [ ] [Create a tag for the new release version](docs/release_process.md#how-to).
+
+/label ~"Engineering Productivity" ~backstage

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gitlab-rubocop.gemspec

data/README.md

@@ -77,6 +77,10 @@ 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/gitlab-styles.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/styles/version'
@@ -13,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(docs|test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/gitlab/styles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab/styles/version'
 
 module Gitlab

data/lib/gitlab/styles/rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab/styles/rubocop/cop/custom_error_class'
 require 'gitlab/styles/rubocop/cop/gem_fetcher'
 require 'gitlab/styles/rubocop/cop/active_record_serialize'

data/lib/gitlab/styles/rubocop/cop/active_record_dependent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -9,7 +11,7 @@ module Gitlab
           include ModelHelpers
 
           MSG = 'Do not use `dependent: to remove associated data, ' \
-            'use foreign keys with cascading deletes instead'.freeze
+            'use foreign keys with cascading deletes instead'
 
           METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
 

data/lib/gitlab/styles/rubocop/cop/active_record_serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -8,7 +10,7 @@ module Gitlab
         class ActiveRecordSerialize < RuboCop::Cop::Cop
           include ModelHelpers
 
-          MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'.freeze
+          MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'
 
           def on_send(node)
             return unless in_model?(node)

data/lib/gitlab/styles/rubocop/cop/custom_error_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -16,7 +18,7 @@ module Gitlab
         #   # good
         #   FooError = Class.new(StandardError)
         class CustomErrorClass < RuboCop::Cop::Cop
-          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'.freeze
+          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'
 
           def on_class(node)
             _klass, parent, body = node.children

data/lib/gitlab/styles/rubocop/cop/gem_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -6,7 +8,7 @@ module Gitlab
         # `Gemfile` in order to avoid additional points of failure beyond
         # rubygems.org.
         class GemFetcher < RuboCop::Cop::Cop
-          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'.freeze
+          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'
 
           GIT_KEYS = [:git, :github].freeze
 

data/lib/gitlab/styles/rubocop/cop/in_batches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -6,7 +8,7 @@ module Gitlab
       module Cop
         # Cop that prevents the use of `in_batches`
         class InBatches < RuboCop::Cop::Cop
-          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'.freeze
+          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'
 
           def on_send(node)
             return unless node.children[1] == :in_batches

data/lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -56,7 +58,7 @@ module Gitlab
         #
         #   do_something_more
         class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
-          MSG = 'Add a line break after guard clauses'.freeze
+          MSG = 'Add a line break after guard clauses'
 
           def_node_matcher :guard_clause_node?, <<-PATTERN
             [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]

data/lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -8,7 +10,7 @@ module Gitlab
         class PolymorphicAssociations < RuboCop::Cop::Cop
           include ModelHelpers
 
-          MSG = 'Do not use polymorphic associations, use separate tables instead'.freeze
+          MSG = 'Do not use polymorphic associations, use separate tables instead'
 
           def on_send(node)
             return unless in_model?(node)

data/lib/gitlab/styles/rubocop/cop/redirect_with_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -5,7 +7,7 @@ module Gitlab
         # This cop prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
         # See https://gitlab.com/gitlab-org/gitlab-ce/issues/31840
         class RedirectWithStatus < RuboCop::Cop::Cop
-          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'.freeze
+          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'
 
           def on_def(node)
             return unless in_controller?(node)

data/lib/gitlab/styles/rubocop/cop/rspec/have_link_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -16,7 +18,7 @@ module Gitlab
           #   expect(page).to have_link('Link', href: 'https://example.com')
           #   expect(page).to have_link('Example')
           class HaveLinkParameters < RuboCop::Cop::RSpec::Cop
-            MESSAGE = "The second argument to `have_link` should be a Hash.".freeze
+            MESSAGE = "The second argument to `have_link` should be a Hash."
 
             def_node_matcher :unused_parameters?, <<~PATTERN
               (send nil? :have_link

data/lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -22,7 +24,7 @@ module Gitlab
           #     undo_something
           #   end
           class SingleLineHook < RuboCop::Cop::RSpec::Cop
-            MESSAGE = "Don't use single-line hook blocks.".freeze
+            MESSAGE = "Don't use single-line hook blocks."
 
             def_node_search :rspec_hook?, <<~PATTERN
               (send nil? {:after :around :before} ...)

data/lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -16,7 +18,7 @@ module Gitlab
           #   describe MyClass, :js do
           #   end
           class VerboseIncludeMetadata < RuboCop::Cop::RSpec::Cop
-            MSG = 'Use `%s` instead of `%s`.'.freeze
+            MSG = 'Use `%s` instead of `%s`.'
 
             SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
 

data/lib/gitlab/styles/rubocop/cop/without_reactive_cache.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
       module Cop
         # Cop that prevents the use of `without_reactive_cache`
         class WithoutReactiveCache < RuboCop::Cop::Cop
-          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'.freeze
+          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'
 
           def on_send(node)
             return unless node.children[1] == :without_reactive_cache

data/lib/gitlab/styles/rubocop/migration_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop

data/lib/gitlab/styles/rubocop/model_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop

data/lib/gitlab/styles/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
-    VERSION = '3.3.0'.freeze
+    VERSION = '3.4.0'
   end
 end

data/rubocop-style.yml

@@ -110,7 +110,7 @@ Style/FormatStringToken:
 
 # Checks if there is a magic comment to enforce string literals
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 # Do not introduce global variables.
 Style/GlobalVars:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: GitLab style guides and shared style configs.