rubocop-discourse 3.9.2 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b3535299ced6e96016ee33586fe7e9b8e0b910c6cc2a441972acb9e3c6b9207
-  data.tar.gz: 99f0a0dd461aebbc1267dba788730ade31af6a02f0709ae51c8afba65b109d98
+  metadata.gz: 5bc9ad5c366f3eee3d8924d4570a420e7ca4bcca8bbcf735c8187a07273868c2
+  data.tar.gz: 1579af93f1fa21a1bdc50f192e39344ad9eef86d999af292ca477aa8fcf14e1a
 SHA512:
-  metadata.gz: 48c1e9c95219737c00fd847c9f030f4e3704147b64dd16cc5a79449cec341535d870f498430afc7b47115ad6edb31adddcc54e145e60d100292fef7576e3b689
-  data.tar.gz: 2b19583ee4c90bb79e1dfcfe5919bf1fe9c13786ecd8a8d6b4cfe0bfaa0fc8952ae280a721631d4968b736ac13c34857290698b989bbcf8ce30dafa57bf6c0d7
+  metadata.gz: 405df3366dae911d28df1895f09479a04115d974a10c81a604337f201234b71dfa20aee185bf13238c9e632ec8e167daf1f700d8e9088e55373689031e68177d
+  data.tar.gz: c8bcf09528c1f785f4476aa3f2f20a9db72be7bccd9a0fe45cbf9a40a0290cbadd9cf3e487c2cb435ddf036f801348ee6569ab951a98573c47dbc10a3db29b34

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
         uses: discourse/publish-rubygems-action@v3

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma,plugin/disable_auto_ternary

data/Gemfile

@@ -6,5 +6,6 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem 'byebug'
+  gem "syntax_tree"
+  gem "byebug"
 end

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

@@ -53,7 +53,7 @@ module RuboCop
           def on_block(node)
             return unless service?
             return unless top_level_block?(node)
-            return if node.single_line?
+            return if node.single_line? || single_block?(node)
 
             if missing_empty_lines?(node)
               add_offense(node, message: MSG) do |corrector|
@@ -78,6 +78,10 @@ module RuboCop
 
           private
 
+          def single_block?(node)
+            !node.ancestors.first.begin_type?
+          end
+
           def service?
             @service
           end

data/lib/rubocop/discourse/plugin.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Discourse
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-discourse",
+          version: RuboCop::Discourse::VERSION,
+          homepage: "https://github.com/discourse/rubocop-discourse",
+          description: "Custom rubocop cops used by Discourse",
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml"),
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/discourse/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Discourse
+    VERSION = "3.10.0"
+  end
+end

data/lib/rubocop-discourse.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require "rubocop"
+require "lint_roller"
 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"
-
-RuboCop::Discourse::Inject.defaults!
-
 require_relative "rubocop/cop/discourse_cops"
+require_relative "rubocop/discourse/version"
+require_relative "rubocop/discourse/plugin"

data/rubocop-discourse.gemspec

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
+require "rubocop/discourse/version"
+
 Gem::Specification.new do |s|
   s.name = "rubocop-discourse"
-  s.version = "3.9.2"
+  s.version = RuboCop::Discourse::VERSION
   s.summary = "Custom rubocop cops used by Discourse"
   s.authors = ["Discourse Team"]
   s.license = "MIT"
@@ -10,14 +14,16 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split($/)
   s.require_paths = ["lib"]
+  s.metadata["default_lint_roller_plugin"] = "RuboCop::Discourse::Plugin"
 
   s.add_runtime_dependency "activesupport", ">= 6.1"
-  s.add_runtime_dependency "rubocop", ">= 1.59.0"
+  s.add_runtime_dependency "rubocop", ">= 1.72.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_runtime_dependency "lint_roller", ">= 1.1.0"
 
   s.add_development_dependency "rake", "~> 13.1.0"
   s.add_development_dependency "rspec", "~> 3.12.0"

data/rubocop-rails.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rails
 
 Rails:

data/rubocop-rspec.yml

@@ -1,5 +1,7 @@
-require:
+plugins:
   - rubocop-rspec
+
+require:
   - rubocop-rspec_rails
 
 RSpec/AnyInstance:

data/spec/lib/rubocop/cop/discourse/services/empty_lines_around_blocks_spec.rb

@@ -128,6 +128,23 @@ RSpec.describe RuboCop::Cop::Discourse::Services::EmptyLinesAroundBlocks,
     end
 
     context "when blocks are nested" do
+      context "when there is just one nested block" do
+        it "does not register an offense" do
+          expect_no_offenses(<<~RUBY)
+            class MyService
+              include Service::Base
+
+              transaction do
+                try do
+                  step :first_step
+                  step :second_step
+                end
+              end
+            end
+          RUBY
+        end
+      end
+
       context "when the nested block is in the first position" do
         context "when there is no empty line before" do
           it "does not register an offense" do

data/stree-compat.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-discourse
 
 inherit_from:

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 3.9.2
+  version: 3.10.0
 platform: ruby
 authors:
 - Discourse Team
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.72.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.59.0
+        version: 1.72.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.30.0
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".streerc"
 - Gemfile
 - LICENSE
 - README.md
@@ -172,8 +187,8 @@ files:
 - lib/rubocop/cop/discourse/services/group_keywords.rb
 - lib/rubocop/cop/discourse/time_eq_matcher.rb
 - lib/rubocop/cop/discourse_cops.rb
-- lib/rubocop/discourse.rb
-- lib/rubocop/discourse/inject.rb
+- lib/rubocop/discourse/plugin.rb
+- lib/rubocop/discourse/version.rb
 - rubocop-capybara.yml
 - rubocop-core.yml
 - rubocop-discourse.gemspec
@@ -208,7 +223,8 @@ files:
 homepage: https://github.com/discourse/rubocop-discourse
 licenses:
 - MIT
-metadata: {}
+metadata:
+  default_lint_roller_plugin: RuboCop::Discourse::Plugin
 rdoc_options: []
 require_paths:
 - lib

data/lib/rubocop/discourse/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Discourse
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end

data/lib/rubocop/discourse.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-  end
-end