rubocop-discourse 3.13.3 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd760fae002d89a13b998aaf4077f886c31d8ea3afd66000b4921760e8e6768
-  data.tar.gz: 31c6b0d5198304e37ee23126d89ed1f0c739557f9e00dd64f7701e7b6797b267
+  metadata.gz: f4d1f21065c28440ac92a435fe615ba1aa71be866decb87a34569b5035b6ab28
+  data.tar.gz: 40738677dd38eb78850b649f223c5e70f86a487821d28ba66ab8e25fb7fe155c
 SHA512:
-  metadata.gz: 9bbb4b4dc1209b4408043fad8e6e2ba010c845da3f2b4c7029faa4b0fb0b4c4a9093624945ab08723646c49757d92e80a538c63ed688800c24ec49b1f10786f5
-  data.tar.gz: e03b63f14b554756ed2e39f5c1a8464f4caa6d358b0b009bb547133a56cc622a8b8785d5a1273305b212b16e0b79bc88374110724d803a1ca6fad802c60ae0d1
+  metadata.gz: 161fab4a916b845fe201a36a7b5cdc6d329a25f4069bdaab7a62a9c0dcd9ed36e0ef3984698de67edf1aac6043351b2201a43550470fff3c86b3e531e132ab0e
+  data.tar.gz: 4a474ac36e50368a4a62fc6e1dba557f2294c9f498a53b28b589eed150a7abc2917a60ba71943d5821c32148876a309f3e4b3ca6eeee1dab9b40fa44d18c45f8

data/README.md

@@ -1,11 +1,43 @@
 # rubocop-discourse
 
-## Usage
+Custom Discourse RuboCop cops plus our shared project configuration (RSpec, Rails, Capybara, FactoryBot). Most Discourse projects use Syntax Tree for formatting, so we recommend the Syntax Tree-compatible config by default.
 
-Add `gem "rubocop-discourse"` to your Gemfile.
-Then add the following to `.rubocop.yml`:
+## Installation
+
+Add the gem to your development group:
+
+```ruby
+group :development, :test do
+  gem "rubocop-discourse"
+end
+```
+
+## Configuration
+
+Recommended (Syntax Tree-friendly, omits Layout cops so it can be used with the formatter):
+
+```yml
+inherit_gem:
+  rubocop-discourse: stree-compat.yml
+```
+
+`stree-compat.yml` includes Discourse cops plus core/RSpec/Rails/Capybara/FactoryBot, but leaves layout to Syntax Tree.
+
+Base config with layout cops (for projects not using Syntax Tree):
 
 ```yml
 inherit_gem:
   rubocop-discourse: default.yml
 ```
+
+`default.yml` is kept for backwards compatibility and pulls in `stree-compat.yml` plus `rubocop-layout.yml`.
+
+Then run `bundle exec rubocop` as usual.
+
+Switching an existing project to Syntax Tree:
+
+```diff
+ inherit_gem:
+-  rubocop-discourse: default.yml # includes layout cops
++  rubocop-discourse: stree-compat.yml # defers layout to Syntax Tree
+```

data/config/default.yml

@@ -56,6 +56,11 @@ Discourse/NoMixingMultisiteAndStandardSpecs:
   Include:
     - "**/spec/**/*"
 
+Discourse/NoSystemSpecMetadata:
+  Enabled: true
+  Include:
+    - "**/spec/**/*"
+
 Discourse/Plugins/CallRequiresPlugin:
   Enabled: true
   Include:

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # System spec metadata is inferred from the file path, so explicit
+      # `type: :system` and `system: true` metadata on `RSpec.describe` is redundant.
+      #
+      # @example
+      #   # bad
+      #   RSpec.describe "login", system: true do
+      #   end
+      #
+      #   # good
+      #   RSpec.describe "login" do
+      #   end
+      class NoSystemSpecMetadata < Base
+        extend AutoCorrector
+
+        MSG = "Remove redundant `type: :system` and `system: true` metadata from `RSpec.describe`."
+        RESTRICT_ON_SEND = %i[describe].freeze
+
+        def_node_matcher :describe?, <<~PATTERN
+          (send
+            {nil? (const nil? :RSpec)}
+            :describe
+            ...
+          )
+        PATTERN
+
+        def_node_matcher :system_type_pair?, <<~PATTERN
+          (pair (sym :type) (sym :system))
+        PATTERN
+
+        def_node_matcher :system_true_pair?, <<~PATTERN
+          (pair (sym :system) true)
+        PATTERN
+
+        def on_send(node)
+          return unless describe?(node)
+          return unless node.last_argument&.hash_type?
+
+          hash = node.last_argument
+          offending_pairs =
+            hash.pairs.select { |pair| system_type_pair?(pair) || system_true_pair?(pair) }
+
+          return if offending_pairs.empty?
+
+          add_offense(offending_pairs.first) do |corrector|
+            corrector.replace(node, corrected_send_source(node, hash, offending_pairs))
+          end
+        end
+
+        private
+
+        def corrected_send_source(node, hash, offending_pairs)
+          remaining_pairs = hash.pairs - offending_pairs
+          before_hash = source_for(node.source_range.begin_pos, hash.source_range.begin_pos)
+          after_hash = source_for(hash.source_range.end_pos, node.source_range.end_pos)
+
+          return "#{before_hash.sub(/,\s*\z/m, "")}#{after_hash}" if remaining_pairs.empty?
+
+          "#{before_hash}#{corrected_hash_source(hash, remaining_pairs)}#{after_hash}"
+        end
+
+        def corrected_hash_source(hash, remaining_pairs)
+          body =
+            remaining_pairs
+              .each_with_index
+              .map do |pair, index|
+                separator = index.zero? ? "" : pair_separator(hash, pair)
+                "#{separator}#{pair.source}"
+              end
+              .join
+
+          return body unless hash.braces?
+
+          return "{ #{body} }" unless hash.multiline?
+
+          indentation = " " * remaining_pairs.first.loc.expression.column
+          closing_indentation = " " * hash.loc.end.column
+
+          "{\n#{indentation}#{body}\n#{closing_indentation}}"
+        end
+
+        def pair_separator(hash, pair)
+          return ", " unless hash.multiline?
+
+          ",\n#{" " * pair.loc.expression.column}"
+        end
+
+        def source_for(begin_pos, end_pos)
+          processed_source.buffer.source[begin_pos...end_pos]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/plugins/call_requires_plugin.rb

@@ -44,8 +44,7 @@ module RuboCop
 
           def requires_plugin_present_in_parent_classes(node)
             return unless processed_source.path
-            controller_path =
-              base_controller_path(node.parent_class&.const_name.to_s)
+            controller_path = base_controller_path(node.parent_class&.const_name.to_s)
             return unless controller_path
             Commissioner
               .new([self.class.new(config, @options)])

data/lib/rubocop/cop/discourse/plugins/no_monkey_patching.rb

@@ -46,14 +46,11 @@ module RuboCop
         #   add_to_serializer(:user, :new_method) { do_processing }
         #
         class NoMonkeyPatching < Base
-          MSG =
-            "Don’t reopen existing classes. Instead, create a mixin and use `prepend`."
-          MSG_CLASS_EVAL =
-            "Don’t call `class_eval`. Instead, create a mixin and use `prepend`."
+          MSG = "Don’t reopen existing classes. Instead, create a mixin and use `prepend`."
+          MSG_CLASS_EVAL = "Don’t call `class_eval`. Instead, create a mixin and use `prepend`."
           MSG_CLASS_EVAL_SERIALIZERS =
             "Don’t call `class_eval` on a serializer. If you’re adding new methods, use `add_to_serializer`. Otherwise, create a mixin and use `prepend`."
-          MSG_SERIALIZERS =
-            "Don’t reopen serializers. Instead, use `add_to_serializer`."
+          MSG_SERIALIZERS = "Don’t reopen serializers. Instead, use `add_to_serializer`."
           RESTRICT_ON_SEND = [:class_eval].freeze
 
           def_node_matcher :existing_class?, <<~MATCHER
@@ -65,18 +62,14 @@ module RuboCop
           MATCHER
 
           def on_send(node)
-            if serializer?(node)
-              return add_offense(node, message: MSG_CLASS_EVAL_SERIALIZERS)
-            end
+            return add_offense(node, message: MSG_CLASS_EVAL_SERIALIZERS) if serializer?(node)
             add_offense(node, message: MSG_CLASS_EVAL)
           end
 
           def on_class(node)
             return unless in_plugin_rb_file?
             return unless existing_class?(node)
-            if serializer?(node)
-              return add_offense(node, message: MSG_SERIALIZERS)
-            end
+            return add_offense(node, message: MSG_SERIALIZERS) if serializer?(node)
             add_offense(node, message: MSG)
           end
 

data/lib/rubocop/cop/discourse/plugins/use_plugin_instance_on.rb

@@ -16,8 +16,7 @@ module RuboCop
         class UsePluginInstanceOn < Base
           MSG =
             "Use `on` instead of `DiscourseEvent.on` as the latter will listen to events even if the plugin is disabled."
-          NOT_OUTSIDE_PLUGIN_RB =
-            "Don’t call `DiscourseEvent.on` outside `plugin.rb`."
+          NOT_OUTSIDE_PLUGIN_RB = "Don’t call `DiscourseEvent.on` outside `plugin.rb`."
           RESTRICT_ON_SEND = [:on].freeze
 
           def_node_matcher :discourse_event_on?, <<~MATCHER

data/lib/rubocop/cop/discourse/services/empty_lines_around_blocks.rb

@@ -57,18 +57,14 @@ module RuboCop
 
             if missing_empty_lines?(node)
               add_offense(node, message: MSG) do |corrector|
-                if missing_empty_line_before?(node) &&
-                     corrected_after.exclude?(node.left_sibling)
+                if missing_empty_line_before?(node) && corrected_after.exclude?(node.left_sibling)
                   corrected_before << node
                   corrector.insert_before(
-                    node.loc.expression.adjust(
-                      begin_pos: -node.loc.expression.column
-                    ),
-                    "\n"
+                    node.loc.expression.adjust(begin_pos: -node.loc.expression.column),
+                    "\n",
                   )
                 end
-                if missing_empty_line_after?(node) &&
-                     corrected_before.exclude?(node.right_sibling)
+                if missing_empty_line_after?(node) && corrected_before.exclude?(node.right_sibling)
                   corrected_after << node
                   corrector.insert_after(node.loc.end, "\n")
                 end
@@ -91,13 +87,11 @@ module RuboCop
           end
 
           def missing_empty_line_before?(node)
-            processed_source[node.loc.expression.line - 2].present? &&
-              node.left_siblings.present?
+            processed_source[node.loc.expression.line - 2].present? && node.left_siblings.present?
           end
 
           def missing_empty_line_after?(node)
-            processed_source[node.loc.end.line].present? &&
-              node.right_siblings.present?
+            processed_source[node.loc.end.line].present? && node.right_siblings.present?
           end
 
           def corrected_before

data/lib/rubocop/cop/discourse/services/group_keywords.rb

@@ -46,9 +46,7 @@ module RuboCop
 
             add_offense(node, message: MSG) do |corrector|
               range =
-                node.loc.expression.end.with(
-                  end_pos: node.right_sibling.loc.expression.begin_pos
-                )
+                node.loc.expression.end.with(end_pos: node.right_sibling.loc.expression.begin_pos)
               content = range.source.gsub(/^(\n)+/, "\n")
               corrector.replace(range, content)
             end
@@ -62,10 +60,7 @@ module RuboCop
 
           def extra_empty_line_after?(node)
             processed_source[node.loc.expression.line].blank? &&
-              (
-                service_keyword?(node.right_sibling) ||
-                  single_line_block?(node.right_sibling)
-              )
+              (service_keyword?(node.right_sibling) || single_line_block?(node.right_sibling))
           end
 
           def service_keyword?(node)

data/lib/rubocop/discourse/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Discourse
-    VERSION = "3.13.3"
+    VERSION = "3.16.0"
   end
 end

data/rubocop-core.yml

@@ -1,143 +1,2 @@
-Security:
-  Enabled: true
-
-Security/IoMethods:
-  Enabled: true
-
-Security/CompoundHash:
-  Enabled: true
-
-# Prefer &&/|| over and/or.
-Style/AndOr:
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-# 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:
-  Enabled: true
-
-Style/SingleLineMethods:
-  Enabled: true
-
-Style/Semicolon:
-  Enabled: true
-  AllowAsExpressionSeparator: true
-
-Style/RedundantReturn:
-  Enabled: true
-
-Style/GlobalVars:
-  Enabled: true
-  Severity: warning
-  Exclude:
-    - "lib/tasks/**/*"
-    - "script/**/*"
-    - "**/spec/**/*"
-
-Style/InvertibleUnlessCondition:
-  Enabled: true
-
-Style/NegatedUnless:
-  Enabled: true
-
-Style/UnlessElse:
-  Enabled: true
-
-Style/UnlessLogicalOperators:
-  Enabled: true
-
-Lint/Debugger:
-  Enabled: true
-
-# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-Lint/RequireParentheses:
-  Enabled: true
-
-Lint/ShadowingOuterLocalVariable:
-  Enabled: true
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Lint/ParenthesesAsGroupedExpression:
-  Enabled: true
-
-Lint/DuplicateMethods:
-  Enabled: true
-
-Lint/RedundantWithIndex:
-  Enabled: true
-
-Lint/RedundantRequireStatement:
-  Enabled: true
-
-Lint/LiteralInInterpolation:
-  Enabled: true
-
-Lint/RedundantStringCoercion:
-  Enabled: true
-
-Lint/BooleanSymbol:
-  Enabled: true
-  AutoCorrect: false # it breaks the code
-
-Lint/ShadowedArgument:
-  Enabled: true
-
-Lint/RedundantCopDisableDirective:
-  Enabled: true
-
-Lint/EmptyEnsure:
-  Enabled: true
-
-Lint/RedundantWithObject:
-  Enabled: true
-
-Lint/SelfAssignment:
-  Enabled: true
-
-Lint/Void:
-  Enabled: true
-
-Lint/UselessMethodDefinition:
-  Enabled: true
-
-Lint/UnreachableCode:
-  Enabled: true
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DisjunctiveAssignmentInConstructor:
-  Enabled: true
-
-Lint/NonLocalExitFromIterator:
-  Enabled: true
-
-Lint/DeprecatedClassMethods:
-  Enabled: true
-
-Lint/SafeNavigationChain:
-  Enabled: true
-
-Lint/RedundantSafeNavigation:
-  Enabled: true
-
-Lint/EmptyConditionalBody:
-  Enabled: true
-
-Lint/SafeNavigationConsistency:
-  Enabled: true
-
-Lint/OrAssignmentToConstant:
-  Enabled: true
+inherit_gem:
+  rubocop-discourse-base: rubocop-core.yml

data/rubocop-discourse.gemspec

@@ -12,12 +12,25 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   s.homepage = "https://github.com/discourse/rubocop-discourse"
 
-  s.files = `git ls-files`.split($/)
+  config_files = %w[
+    default.yml
+    rubocop-core.yml
+    rubocop-layout.yml
+    rubocop-capybara.yml
+    rubocop-factory_bot.yml
+    rubocop-rspec.yml
+    rubocop-rails.yml
+    stree-compat.yml
+    config/default.yml
+  ]
+
+  s.files = %w[LICENSE README.md rubocop-discourse.gemspec] + config_files + Dir["lib/**/*.rb"]
   s.require_paths = ["lib"]
   s.metadata["default_lint_roller_plugin"] = "RuboCop::Discourse::Plugin"
 
+  s.required_ruby_version = ">= 3.0"
   s.add_runtime_dependency "activesupport", ">= 6.1"
-  s.add_runtime_dependency "rubocop", ">= 1.73.2"
+  s.add_runtime_dependency "rubocop-discourse-base", ">= 1.0.0"
   s.add_runtime_dependency "rubocop-rspec", ">= 3.0.1"
   s.add_runtime_dependency "rubocop-factory_bot", ">= 2.27.0"
   s.add_runtime_dependency "rubocop-capybara", ">= 2.22.0"

data/rubocop-layout.yml

@@ -1,80 +1,2 @@
-# Align `when` with `case`.
-Layout/CaseIndentation:
-  Enabled: true
-
-# Align comments with method definitions.
-Layout/CommentIndentation:
-  Enabled: true
-
-# No extra empty lines.
-Layout/EmptyLines:
-  Enabled: true
-
-# Use empty lines between definitions.
-Layout/EmptyLineBetweenDefs:
-  Enabled: true
-
-# Two spaces, no tabs (for indentation).
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/SpaceAfterColon:
-  Enabled: true
-
-Layout/SpaceAfterComma:
-  Enabled: true
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-Layout/SpaceAroundKeyword:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeFirstArg:
-  Enabled: true
-
-# Use `foo {}` not `foo{}`.
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Use `foo { bar }` not `foo {bar}`.
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-
-# Use `{ a: 1 }` not `{a:1}`.
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-# Detect hard tabs, no hard tabs.
-Layout/IndentationStyle:
-  Enabled: true
-
-# Blank lines should not have any spaces.
-Layout/TrailingEmptyLines:
-  Enabled: true
-
-# No trailing whitespace.
-Layout/TrailingWhitespace:
-  Enabled: true
-
-Layout/BlockAlignment:
-  Enabled: true
-
-# Align `end` with the matching keyword or starting expression except for
-# assignments, where it should be aligned with the LHS.
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Layout/HashAlignment:
-  Enabled: true
+inherit_gem:
+  rubocop-discourse-base: rubocop-layout.yml