rubocop-discourse 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41746c69c5012edbafa4e2f85d902a55a72235316897c0a5afdff69a7b7abbda
-  data.tar.gz: b0128a77bf8387b94c7797c6e3df26a0eb1b0ffb68a87122b005e34aab13a448
+  metadata.gz: 829d3722889a6cda57c4d83a8531fb72d041c868b958f0ce95eac9c66f9fcf3d
+  data.tar.gz: 9d51dd30c4e5a03ade1e948fd720f5804f3a787e6fa3f21ef0949e07e7e61e6a
 SHA512:
-  metadata.gz: abf20aff53a75d624eeb703a3bb86036486ebb6b5dd67b5255312eb8eb7e2ffb04cd57f3cf6ae173bff02a8bee6042fe93acaf038851c2a06011a082e91fd382
-  data.tar.gz: 53b2e0e2bed1e95f94531819aa4f0c5595e1627231f53f626e6f557c59ab42d854f58362211ae8ff23fa60b5ebea4454185de2d9c4ce0322c71f2ed4e89c91e9
+  metadata.gz: 323f7c0b2994ccccfa9e5d75cc431caefa7de8cf7f6738c2e87030d8b4ee0454349faa7102bc8c9e2a0eafb76ad0597f1ef58d3afb8b7aff223216b20a2ab774
+  data.tar.gz: 8c262ddadf1dd0d78340093a01a181962c1123f49305bd2c20a34ce1669948d7bd1de9f2c9f950f0f5739234fb308b6c86ff368d18b915b9a6220c7dba95af83

data/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.6'
+          ruby-version: '3.2'
           bundler-cache: true
 
       - name: Rubocop

data/config/default.yml

@@ -13,8 +13,8 @@ Discourse/NoURIEscapeEncode:
 Discourse/NoAddReferenceOrAliasesActiveRecordMigration:
   Enabled: true
   Include:
-  - "**/db/migrate/*"
-  - "**/db/post_migrate/*"
+    - '**/db/migrate/*'
+    - '**/db/post_migrate/*'
 
 Discourse/NoNokogiriHtmlFragment:
   Enabled: true
@@ -22,43 +22,43 @@ Discourse/NoNokogiriHtmlFragment:
 Discourse/NoResetColumnInformationInMigrations:
   Enabled: false
   Include:
-  - "**/db/migrate/*"
-  - "**/db/post_migrate/*"
+    - '**/db/migrate/*'
+    - '**/db/post_migrate/*'
 
 # Specs
 
 Discourse/NoDirectMultisiteManipulation:
   Enabled: true
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'
 
 Discourse/TimeEqMatcher:
   Enabled: true
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'
 
 Discourse/NoJsonParseResponse:
   Enabled: false
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'
 
 Discourse/NoMockingJobs:
   Enabled: true
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'
 
 Discourse/OnlyTopLevelMultisiteSpecs:
   Enabled: true
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'
 
 Discourse/NoMixingMultisiteAndStandardSpecs:
   Enabled: true
   Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+    - _spec.rb
+    - '(?:^|/)spec/'

data/lib/rubocop/cop/discourse/no_add_reference_active_record_migrations.rb

@@ -70,12 +70,14 @@ module RuboCop
         MATCHER
 
         def on_send(node)
-          return if [
-            using_add_reference?(node),
-            using_add_belongs_to?(node),
-            using_t_references?(node),
-            using_t_belongs_to?(node)
-          ].none?
+          if [
+               using_add_reference?(node),
+               using_add_belongs_to?(node),
+               using_t_references?(node),
+               using_t_belongs_to?(node)
+             ].none?
+            return
+          end
           add_offense(node, message: MSG)
         end
       end

data/lib/rubocop/cop/discourse/no_direct_multisite_manipulation.rb

@@ -17,7 +17,8 @@ module RuboCop
       #     do_something
       #   end
       class NoDirectMultisiteManipulation < Cop
-        MSG = "Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`."
+        MSG =
+          "Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`."
 
         def_node_matcher :multisite_setter?, <<-MATCHER
           (send

data/lib/rubocop/cop/discourse/no_json_parse_response.rb

@@ -12,7 +12,8 @@ module RuboCop
       #   # good
       #   expect(response.parsed_body).to eq({})
       class NoJsonParseResponse < Cop
-        MSG = "Use `response.parsed_body` instead of `JSON.parse(response.body)` in specs."
+        MSG =
+          "Use `response.parsed_body` instead of `JSON.parse(response.body)` in specs."
 
         def_node_matcher :json_parse_body?, <<-MATCHER
           (send

data/lib/rubocop/cop/discourse/no_mixing_multisite_and_standard_specs.rb

@@ -24,7 +24,8 @@ module RuboCop
       #   describe "x", type: :multisite do
       #   end
       class NoMixingMultisiteAndStandardSpecs < Cop
-        MSG = "Do not mix multisite and standard specs. Consider moving multisite describes to a separate file."
+        MSG =
+          "Do not mix multisite and standard specs. Consider moving multisite describes to a separate file."
 
         def initialize(config = nil, options = nil)
           super
@@ -64,11 +65,7 @@ module RuboCop
         MATCHER
 
         def top_level?(node)
-          if node.parent&.begin_type?
-            node.parent.root?
-          else
-            node.root?
-          end
+          node.parent&.begin_type? ? node.parent.root? : node.root?
         end
       end
     end

data/lib/rubocop/cop/discourse/no_mocking_jobs.rb

@@ -4,7 +4,8 @@ module RuboCop
   module Cop
     module Discourse
       class NoMockingJobs < Cop
-        MSG = "Use the test helpers provided by Sidekiq instead of mocking `Jobs.expects(:enqueue)`."
+        MSG =
+          "Use the test helpers provided by Sidekiq instead of mocking `Jobs.expects(:enqueue)`."
 
         def_node_matcher :mocking_jobs_enqueue?, <<~MATCHER
         (send (const nil? :Jobs) :expects (:sym :enqueue))

data/lib/rubocop/cop/discourse/no_reset_column_information_in_migrations.rb

@@ -8,10 +8,11 @@ module RuboCop
       # concurrently for multisites. Also, we don't encourage the use of
       # ActiveRecord methods in migrations and prefer to write SQL directly.
       class NoResetColumnInformationInMigrations < Cop
-        MSG = "ActiveRecord::ModelSchema.reset_column_information is not thread-safe " \
-          "and we run migrations concurrently on multisite clusters. Using this " \
-          "method also means ActiveRecord methods are being used in migration "\
-          "which is discouraged at Discourse. Instead, you should write SQL in your migrations instead."
+        MSG =
+          "ActiveRecord::ModelSchema.reset_column_information is not thread-safe " \
+            "and we run migrations concurrently on multisite clusters. Using this " \
+            "method also means ActiveRecord methods are being used in migration " \
+            "which is discouraged at Discourse. Instead, you should write SQL in your migrations instead."
 
         def on_send(node)
           return if node.method_name != :reset_column_information

data/lib/rubocop/cop/discourse/no_uri_escape_encode.rb

@@ -16,7 +16,8 @@ module RuboCop
       #   UrlHelper.encode("https://a%20a.com?a='a%22")
       #   Addressable::URI.encode("https://a%20a.com?a='a%22")
       class NoURIEscapeEncode < Cop
-        MSG = "URI.escape, URI.encode, URI.unescape, URI.decode are deprecated and should not be used."
+        MSG =
+          "URI.escape, URI.encode, URI.unescape, URI.decode are deprecated and should not be used."
 
         def_node_matcher :using_uri_escape?, <<-MATCHER
           (send (const nil? :URI) :escape ...)
@@ -35,12 +36,14 @@ module RuboCop
         MATCHER
 
         def on_send(node)
-          return if [
-            using_uri_escape?(node),
-            using_uri_encode?(node),
-            using_uri_unescape?(node),
-            using_uri_decode?(node)
-          ].none?
+          if [
+               using_uri_escape?(node),
+               using_uri_encode?(node),
+               using_uri_unescape?(node),
+               using_uri_decode?(node)
+             ].none?
+            return
+          end
           add_offense(node, message: MSG)
         end
       end

data/lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb

@@ -47,11 +47,7 @@ module RuboCop
         MATCHER
 
         def top_level?(node)
-          if node.parent&.begin_type?
-            node.parent.root?
-          else
-            node.root?
-          end
+          node.parent&.begin_type? ? node.parent.root? : node.root?
         end
       end
     end

data/lib/rubocop/discourse.rb

@@ -3,9 +3,9 @@
 module RuboCop
   # RuboCop Discourse project namespace
   module Discourse
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end

data/rubocop-core.yml

@@ -4,6 +4,9 @@ Security:
 Security/IoMethods:
   Enabled: true
 
+Security/CompoundHash:
+  Enabled: true
+
 # Prefer &&/|| over and/or.
 Style/AndOr:
   Enabled: true
@@ -14,6 +17,7 @@ Style/FrozenStringLiteralComment:
 # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
 Style/HashSyntax:
   Enabled: true
+  EnforcedShorthandSyntax: either
 
 # Defining a method with parameters needs parentheses.
 Style/MethodDefParentheses:

data/rubocop-discourse.gemspec

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 Gem::Specification.new do |s|
-  s.name        = "rubocop-discourse"
-  s.version     = "3.1.0"
-  s.summary     = "Custom rubocop cops used by Discourse"
-  s.authors     = ["Discourse Team"]
-  s.license     = "MIT"
-  s.homepage    = "https://github.com/discourse/rubocop-discourse"
+  s.name = "rubocop-discourse"
+  s.version = "3.2.0"
+  s.summary = "Custom rubocop cops used by Discourse"
+  s.authors = ["Discourse Team"]
+  s.license = "MIT"
+  s.homepage = "https://github.com/discourse/rubocop-discourse"
 
   s.files = `git ls-files`.split($/)
   s.require_paths = ["lib"]

data/rubocop-rspec.yml

@@ -31,17 +31,17 @@ RSpec/ContextWording:
 RSpec/DescribeClass:
   Enabled: true
   Exclude:
-    - "**/spec/features/**/*"
-    - "**/spec/requests/**/*"
-    - "**/spec/routing/**/*"
-    - "**/spec/system/**/*"
-    - "**/spec/views/**/*"
-    - "**/spec/initializers/**/*"
-    - "**/spec/integration/**/*"
-    - "**/spec/integrity/**/*"
-    - "**/spec/tasks/**/*"
-    - "**/spec/lib/freedom_patches/**/*"
-    - "**/spec/multisite/**/*"
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - '**/spec/initializers/**/*'
+    - '**/spec/integration/**/*'
+    - '**/spec/integrity/**/*'
+    - '**/spec/tasks/**/*'
+    - '**/spec/lib/freedom_patches/**/*'
+    - '**/spec/multisite/**/*'
 
 RSpec/DescribeMethod:
   Enabled: true
@@ -213,7 +213,7 @@ RSpec/VoidExpect:
 RSpec/Yield:
   Enabled: true
 
-RSpec/Capybara/CurrentPathExpectation:
+Capybara/CurrentPathExpectation:
   Enabled: true
 
 RSpec/Capybara/FeatureMethods:

data/spec/lib/rubocop/cop/no_add_reference_active_record_migrations_spec.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration, :config do
+describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration,
+         :config do
   subject(:cop) { described_class.new(config) }
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if add_reference is used, with or without arguments" do
     inspect_source(<<~RUBY)

data/spec/lib/rubocop/cop/no_mixing_multisite_and_standard_specs_spec.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if there are multisite and standard top-level describes" do
     inspect_source(<<~RUBY)

data/spec/lib/rubocop/cop/no_mocking_jobs_enqueue_spec.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RuboCop::Cop::Discourse::NoMockingJobs, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if Jobs is mocked with :enqueue" do
     inspect_source(<<~RUBY)

data/spec/lib/rubocop/cop/no_reset_column_information_migrations_spec.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config do
+describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations,
+         :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if reset_column_information is used" do
     inspect_source(<<~RUBY)

data/spec/lib/rubocop/cop/only_top_level_multisite_specs_spec.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if multisite config option is used in a sub-describe" do
     inspect_source(<<~RUBY)

data/spec/lib/rubocop/cop/time_eq_matcher_spec.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RuboCop::Cop::Discourse::TimeEqMatcher, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if a timestamp is compared using `eq`" do
     inspect_source(<<~RUBY)

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
+require "bundler/setup"
 Bundler.setup
 
 # Require supporting files exposed for testing.
-require 'rubocop'
-require 'rubocop/rspec/support'
+require "rubocop"
+require "rubocop/rspec/support"
 
-require 'rubocop-discourse' # and any other gems you need
+require "rubocop-discourse" # and any other gems you need
 
 RSpec.configure do |config|
   config.include RuboCop::RSpec::ExpectOffense

data/stree-compat.yml

@@ -6,16 +6,16 @@ inherit_from:
   - ./rubocop-rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
   DisabledByDefault: true
   Exclude:
-    - "db/schema.rb"
-    - "bundle/**/*"
-    - "vendor/**/*"
-    - "**/node_modules/**/*"
-    - "public/**/*"
-    - "plugins/**/gems/**/*"
-    - "plugins/**/vendor/**/*"
+    - 'db/schema.rb'
+    - 'bundle/**/*'
+    - 'vendor/**/*'
+    - '**/node_modules/**/*'
+    - 'public/**/*'
+    - 'plugins/**/gems/**/*'
+    - 'plugins/**/vendor/**/*'
 
 Discourse:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Discourse Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop