rubocop-discourse 3.1.0 → 3.9.3

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Using `DiscourseEvent.on` leaves the handler enabled when the plugin is disabled.
+        #
+        # @example
+        #   # bad
+        #   DiscourseEvent.on(:event) { do_something }
+        #
+        #   # good
+        #   on(:event) { do_something }
+        #
+        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`."
+          RESTRICT_ON_SEND = [:on].freeze
+
+          def_node_matcher :discourse_event_on?, <<~MATCHER
+            (send (const nil? :DiscourseEvent) :on _)
+          MATCHER
+
+          def on_send(node)
+            return unless discourse_event_on?(node)
+            return add_offense(node, message: MSG) if in_plugin_rb_file?
+            add_offense(node, message: NOT_OUTSIDE_PLUGIN_RB)
+          end
+
+          private
+
+          def in_plugin_rb_file?
+            processed_source.path.split("/").last == "plugin.rb"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Use `require_relative` to load dependencies.
+        #
+        # @example
+        #   # bad
+        #   load File.expand_path("../lib/my_file.rb", __FILE__)
+        #
+        #   # good
+        #   require_relative "lib/my_file"
+        #
+        class UseRequireRelative < Base
+          MSG = "Use `require_relative` instead of `load`."
+          RESTRICT_ON_SEND = [:load].freeze
+
+          def_node_matcher :load_called?, <<~MATCHER
+            (send nil? :load _)
+          MATCHER
+
+          def on_send(node)
+            return unless load_called?(node)
+            add_offense(node, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Services
+        # Put empty lines around multiline blocks.
+        #
+        # @example
+        #   # bad
+        #   model :my_model
+        #   params do
+        #     attribute :my_attribute
+        #     validates :my_attribute, presence: true
+        #   end
+        #   policy :my_policy
+        #   step :another_step
+        #
+        #   # good
+        #   model :my_model
+        #
+        #   params do
+        #     attribute :my_attribute
+        #     validates :my_attribute, presence: true
+        #   end
+        #
+        #   policy :my_policy
+        #   step :another_step
+        #
+        class EmptyLinesAroundBlocks < Base
+          extend AutoCorrector
+
+          MSG = "Add empty lines around a step block."
+
+          def_node_matcher :service_include?, <<~MATCHER
+            (class _ _
+             {
+               (begin <(send nil? :include (const (const nil? :Service) :Base)) ...>)
+               <(send nil? :include (const (const nil? :Service) :Base)) ...>
+             }
+            )
+          MATCHER
+
+          def_node_matcher :top_level_block?, <<~MATCHER
+            (block (send nil? _) ...)
+          MATCHER
+
+          def on_class(node)
+            return unless service_include?(node)
+            @service = true
+          end
+
+          def on_block(node)
+            return unless service?
+            return unless top_level_block?(node)
+            return if node.single_line? || single_block?(node)
+
+            if missing_empty_lines?(node)
+              add_offense(node, message: MSG) do |corrector|
+                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"
+                  )
+                end
+                if missing_empty_line_after?(node) &&
+                     corrected_before.exclude?(node.right_sibling)
+                  corrected_after << node
+                  corrector.insert_after(node.loc.end, "\n")
+                end
+              end
+            end
+          end
+
+          private
+
+          def single_block?(node)
+            !node.ancestors.first.begin_type?
+          end
+
+          def service?
+            @service
+          end
+
+          def missing_empty_lines?(node)
+            missing_empty_line_before?(node) || missing_empty_line_after?(node)
+          end
+
+          def missing_empty_line_before?(node)
+            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?
+          end
+
+          def corrected_before
+            @corrected_before ||= []
+          end
+
+          def corrected_after
+            @corrected_before ||= []
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Services
+        # Don’t put empty lines between keywords that are not multiline blocks.
+        #
+        # @example
+        #   # bad
+        #   model :my_model
+        #
+        #   policy :my_policy
+        #
+        #   try { step :might_raise }
+        #
+        #   # good
+        #   model :my_model
+        #   policy :my_policy
+        #   try { step :might_raise }
+        #
+        class GroupKeywords < Base
+          extend AutoCorrector
+
+          MSG = "Group one-liner steps together by removing extra empty lines."
+          RESTRICT_ON_SEND = %i[step model policy].freeze
+
+          def_node_matcher :service_include?, <<~MATCHER
+            (class _ _
+             {
+               (begin <(send nil? :include (const (const nil? :Service) :Base)) ...>)
+               <(send nil? :include (const (const nil? :Service) :Base)) ...>
+             }
+            )
+          MATCHER
+
+          def on_class(node)
+            return unless service_include?(node)
+            @service = true
+          end
+
+          def on_send(node)
+            return unless service?
+            return unless top_level?(node)
+            return unless extra_empty_line_after?(node)
+
+            add_offense(node, message: MSG) do |corrector|
+              range =
+                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
+          end
+
+          private
+
+          def service?
+            @service
+          end
+
+          def extra_empty_line_after?(node)
+            processed_source[node.loc.expression.line].blank? &&
+              (
+                service_keyword?(node.right_sibling) ||
+                  single_line_block?(node.right_sibling)
+              )
+          end
+
+          def service_keyword?(node)
+            return unless node
+            node.send_type? && RESTRICT_ON_SEND.include?(node.method_name)
+          end
+
+          def single_line_block?(node)
+            return unless node
+            node.block_type? && node.single_line?
+          end
+
+          def top_level?(node)
+            while (!node.root?)
+              node = node.parent
+              return if %i[begin class block].exclude?(node.type)
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module RuboCop
       #
       #   # good
       #   expect(user.created_at).to eq_time(Time.zone.now)
-      class TimeEqMatcher < Cop
+      class TimeEqMatcher < Base
         MSG = "Use eq_time when testing timestamps"
 
         def_node_matcher :using_eq_matcher_with_timestamp?, <<-MATCHER
@@ -29,9 +29,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.children.last.loc.selector, "eq_time")
-          end
+          lambda { |corrector| corrector.replace(node.children.last.loc.selector, "eq_time") }
         end
 
         private

data/lib/rubocop/cop/discourse_cops.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-path = File.join(__dir__, "discourse", "*.rb")
+path = File.join(__dir__, "discourse", "**/*.rb")
 Dir[path].each { |file| require file }

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/lib/rubocop-discourse.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require "rubocop"
+require "active_support"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/enumerable"
 require_relative "rubocop/discourse"
 require_relative "rubocop/discourse/inject"
 

data/rubocop-capybara.yml

@@ -0,0 +1,5 @@
+require:
+  - rubocop-capybara
+
+Capybara/CurrentPathExpectation:
+  Enabled: true

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:
@@ -33,10 +37,9 @@ Style/GlobalVars:
   Enabled: true
   Severity: warning
   Exclude:
-    - 'lib/tasks/**/*'
-    - 'script/**/*'
-    - 'spec/**/*.rb'
-    - 'plugins/*/spec/**/*'
+    - "lib/tasks/**/*"
+    - "script/**/*"
+    - "**/spec/**/*"
 
 Style/InvertibleUnlessCondition:
   Enabled: true
@@ -65,3 +68,77 @@ Bundler/OrderedGems:
 
 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
+  AutoCorrect: false # it can break the code
+
+Lint/SafeNavigationConsistency:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true

data/rubocop-discourse.gemspec

@@ -1,19 +1,24 @@
 # 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.9.3"
+  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"]
 
-  s.add_runtime_dependency "rubocop", ">= 1.1.0"
-  s.add_runtime_dependency "rubocop-rspec", ">= 2.0.0"
+  s.add_runtime_dependency "activesupport", ">= 6.1"
+  s.add_runtime_dependency "rubocop", ">= 1.59.0"
+  s.add_runtime_dependency "rubocop-rspec", ">= 3.0.1"
+  s.add_runtime_dependency "rubocop-factory_bot", ">= 2.0.0"
+  s.add_runtime_dependency "rubocop-capybara", ">= 2.0.0"
+  s.add_runtime_dependency "rubocop-rails", ">= 2.25.0"
+  s.add_runtime_dependency "rubocop-rspec_rails", ">= 2.30.0"
 
-  s.add_development_dependency "rake", "~> 13.0"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake", "~> 13.1.0"
+  s.add_development_dependency "rspec", "~> 3.12.0"
 end

data/rubocop-factory_bot.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-factory_bot
+
+FactoryBot/AttributeDefinedStatically:
+  Enabled: true
+
+FactoryBot/CreateList:
+  Enabled: true
+
+FactoryBot/FactoryClassName:
+  Enabled: true

data/rubocop-layout.yml

@@ -10,6 +10,10 @@ Layout/CommentIndentation:
 Layout/EmptyLines:
   Enabled: true
 
+# Use empty lines between definitions.
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
 # Two spaces, no tabs (for indentation).
 Layout/IndentationWidth:
   Enabled: true

data/rubocop-rails.yml

@@ -0,0 +1,14 @@
+require:
+  - rubocop-rails
+
+Rails:
+  Enabled: false
+
+Rails/EnumHash:
+  Enabled: true
+
+Rails/EnumUniqueness:
+  Enabled: true
+
+Rails/ReversibleMigrationMethodDefinition:
+  Enabled: true

data/rubocop-rspec.yml

@@ -1,5 +1,6 @@
 require:
   - rubocop-rspec
+  - rubocop-rspec_rails
 
 RSpec/AnyInstance:
   Enabled: false # To be decided
@@ -27,6 +28,7 @@ RSpec/ContextWording:
     - if
     - as
     - after
+    - in
 
 RSpec/DescribeClass:
   Enabled: true
@@ -53,12 +55,12 @@ RSpec/DescribedClass:
   Enabled: false # To be decided
 
 RSpec/DescribedClassModuleWrapping:
-  Enabled: false # To be decided
+  Enabled: true
 
 RSpec/EmptyExampleGroup:
   Enabled: true
   Exclude:
-    - 'spec/requests/api/*'
+    - "spec/requests/api/*"
 
 RSpec/EmptyLineAfterExample:
   Enabled: false # TODO
@@ -73,7 +75,7 @@ RSpec/EmptyLineAfterHook:
   Enabled: false # TODO
 
 RSpec/EmptyLineAfterSubject:
-  Enabled: false # TODO
+  Enabled: true
 
 RSpec/ExampleLength:
   Enabled: false # To be decided
@@ -91,14 +93,17 @@ RSpec/ExpectChange:
   Enabled: false # To be decided
 
 RSpec/ExpectInHook:
-  Enabled: false # To be decided
+  Enabled: false
 
 RSpec/ExpectOutput:
   Enabled: true
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Enabled: false # To be decided
 
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
 RSpec/Focus:
   Enabled: true
 
@@ -130,7 +135,7 @@ RSpec/IteratedExpectation:
   Enabled: false # To be decided
 
 RSpec/LeadingSubject:
-  Enabled: false # TODO
+  Enabled: true
 
 RSpec/LeakyConstantDeclaration:
   Enabled: false # To be decided
@@ -150,14 +155,20 @@ RSpec/MessageSpies:
 RSpec/MissingExampleGroupArgument:
   Enabled: true
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 RSpec/MultipleDescribes:
   Enabled: false # TODO
 
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 RSpec/MultipleSubjects:
   Enabled: true
 
 RSpec/NamedSubject:
-  Enabled: false # To be decided
+  Enabled: true
 
 RSpec/NestedGroups:
   Enabled: false # To be decided
@@ -172,7 +183,7 @@ RSpec/ReceiveNever:
   Enabled: true
 
 RSpec/RepeatedDescription:
-  Enabled: false # TODO
+  Enabled: false
 
 RSpec/RepeatedExample:
   Enabled: false # TODO
@@ -181,7 +192,7 @@ RSpec/RepeatedExampleGroupBody:
   Enabled: false # TODO
 
 RSpec/RepeatedExampleGroupDescription:
-  Enabled: false # TODO
+  Enabled: false
 
 RSpec/ReturnFromStub:
   Enabled: true
@@ -213,20 +224,15 @@ RSpec/VoidExpect:
 RSpec/Yield:
   Enabled: true
 
-RSpec/Capybara/CurrentPathExpectation:
-  Enabled: true
-
-RSpec/Capybara/FeatureMethods:
-  Enabled: true
-
-RSpec/FactoryBot/AttributeDefinedStatically:
-  Enabled: true
-
-RSpec/FactoryBot/CreateList:
-  Enabled: true
-
-RSpec/FactoryBot/FactoryClassName:
+RSpec/Dialect:
   Enabled: true
+  PreferredMethods:
+    background: :before
+    scenario: :it
+    xscenario: :xit
+    given: :let
+    given!: :let!
+    feature: :describe
 
-RSpec/Rails/HttpStatus:
+RSpecRails/HttpStatus:
   Enabled: true

data/spec/fixtures/controllers/bad_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class BadController < NoRequiresPluginController
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/CallRequiresPlugin: Use `requires_plugin` in controllers to prevent routes from being accessible when plugin is disabled.
+end

data/spec/fixtures/controllers/base_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class BaseController
+  class << self
+    def requires_plugin(*)
+    end
+
+    def requires_login
+    end
+  end
+end

data/spec/fixtures/controllers/good_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class GoodController < RequiresPluginController
+end

data/spec/fixtures/controllers/inherit_from_outside_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class InheritFromOutsideController < ApplicationController
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/CallRequiresPlugin: Use `requires_plugin` in controllers to prevent routes from being accessible when plugin is disabled.
+end