rubocop-zuno 3.7.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abeffc4f1ebb6d9b00823168fc7f249b7c3a6a3d3b3b9396c1563702d2f807d7
-  data.tar.gz: ba21fcf47c8a865f8c09a5900924cde984216cfb06f75bf646084e630de1beeb
+  metadata.gz: c1e3ebc0f9cc20ba64a567f51be91f58526da27ea646a81de15508dfd5fa1dd1
+  data.tar.gz: fc0694c79dfd2641c671d73a2bec3f0df5117e6c45b11bed4d80b09d73e99ca3
 SHA512:
-  metadata.gz: 1b2188b5d86409077d9735eb1a812d701e47eef1ae5f334ad1722c7b6cda36ab16573b17f0ab68bffd6ecf6a745882c19d8cf1fc9b07e1f519d6bba6d7f40710
-  data.tar.gz: 571d4ccdf9d83e5b51d15f492314148eca9e123d8c5a36a3c16d741f365855e6b755b2bffa3ddaaa94c5df57fd1e77e5a1aa0c3c21fd8c340f21634a3552a8a1
+  metadata.gz: d6993828c2a427e789769932d023f8b205602c95ab62e0ceb89c2e2ab1e26d019c17c39abc008b6ee73c6ba914cfa0b425f215db45483067391cbf6e24b5c0ab
+  data.tar.gz: 20192b8523c440f61c1626efd71de74277199224dd920ff6d34d840ffa8533f26d91d02a103ac7fa862d784340d2d99157166cdbf2f1875129e610a23ac72b4e

data/README.md

@@ -7,7 +7,7 @@ Base [Rubocop](https://rubocop.org) settings for all Zuno Ruby projects.
 
 ## Requirements
 
-- Ruby >= 3.0
+- Ruby >= 3.2
 
 ## Installation
 
@@ -31,7 +31,7 @@ bundle
 Put this into your .rubocop.yml.
 
 ```yml
-require:
+plugins:
   - rubocop-zuno
 ```
 
@@ -73,19 +73,20 @@ The following Rubocop gems are also installed with this gem:
 - [rubocop-rake](https://github.com/rubocop-hq/rubocop-rake)
 - [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec)
 
-To enable these add the following to your `.rubocop.yml` file.
+`rubocop-rails` and `rubocop-rspec` are loaded automatically when you inherit `rails.yml` or `rspec.yml` from this gem.
+
+If you want to use cops from `rubocop-faker` or `rubocop-factory_bot`, add the relevant plugin to your `.rubocop.yml` file.
 
 ```yml
+plugins:
+  - rubocop-zuno
+  - rubocop-faker # if your project uses the Faker gem
+  - rubocop-factory_bot # if your project uses FactoryBot
+
 inherit_gem:
   rubocop-zuno:
-  # .... add cops
-
-require:
-  - rubocop-faker # if your project is using the Faker gem then add this
-  - rubocop-performance # Add this for performance cops
-  - rubocop-rails # if your project is a Rails app/engine then add this, plus the - rails.yml setting above
-  - rubocop-rake # if your project is using rake then add this
-  - rubocop-rspec # if your project is using rspec then add this, plus the - rspec.yml setting above
+    - rails.yml # if your project is a Rails app or engine
+    - rspec.yml # if your project uses RSpec
 ```
 
 ## Editor Plugins

data/VERSION

@@ -1 +1 @@
-3.7.0
+4.0.0

data/config/default.yml

@@ -1,3 +1,7 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+
 AllCops:
   Exclude:
     - "**/*/schema.rb"

data/lib/rubocop/zuno/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Zuno
+    # A plugin that integrates RuboCop Zuno with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-zuno",
+          version: RuboCop::Zuno::VERSION,
+          homepage: "https://github.com/zuno-tech/rubocop-zuno",
+          description: "Base RuboCop settings for all Zuno Ruby projects"
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: CONFIG_DEFAULT
+        )
+      end
+    end
+  end
+end

data/lib/rubocop-zuno.rb

@@ -4,8 +4,6 @@ require "rubocop"
 
 require_relative "rubocop/zuno"
 require_relative "rubocop/zuno/version"
-require_relative "rubocop/zuno/inject"
-
-RuboCop::Zuno::Inject.defaults!
+require_relative "rubocop/zuno/plugin"
 
 require_relative "rubocop/cop/zuno_cops"

data/rails.yml

@@ -1,3 +1,6 @@
+plugins:
+  - rubocop-rails
+
 Rails/ApplicationController:
   Exclude:
     - spec/**/*

data/rspec.yml

@@ -1,3 +1,7 @@
+plugins:
+  - rubocop-rspec
+  - rubocop-rspec_rails
+
 # Excluding as we set up the rake specs as 'describe "rake namespace:task", type: :task do' which determines what task
 # is being tested, and this cop doesn't like having a describe block without a class or module name.
 RSpec/DescribeClass:
@@ -8,15 +12,18 @@ RSpec/DescribeClass:
 RSpec/DescribedClassModuleWrapping:
   Enabled: true
 
-# This is to prevent Rubocop from bugging on a spec helper that doesn't contain an example, which the support ones don't
-RSpec/LeadingSubject:
-  Exclude:
-    - spec/support
-
 # Allow arrays, hashes, and method calls to be counted as one line in examples
 RSpec/ExampleLength:
   CountAsOne: ["array", "hash", "method_call"]
 
+# Multi-line examples must have a description
+RSpec/ExampleWithoutDescription:
+  EnforcedStyle: single_line_only
+
+# This is to prevent Rubocop from bugging on a spec helper that doesn't contain an example, which the support ones don't
+RSpec/LeadingSubject:
+  Exclude:
+    - spec/support
 # Because 5 is a bit mean
 RSpec/MultipleMemoizedHelpers:
   Max: 10
@@ -24,7 +31,3 @@ RSpec/MultipleMemoizedHelpers:
 # Allow there to be a max of 4 example groups deep in Rspec tests
 RSpec/NestedGroups:
   Max: 4
-
-# Multi-line examples must have a description
-RSpec/ExampleWithoutDescription:
-  EnforcedStyle: single_line_only

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-zuno
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Zuno
@@ -9,20 +9,34 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.86.0
+        version: 1.86.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.86.0
+        version: 1.86.1
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +152,7 @@ files:
 - lib/rubocop/cop/zuno/api_type_parameters.rb
 - lib/rubocop/cop/zuno_cops.rb
 - lib/rubocop/zuno.rb
-- lib/rubocop/zuno/inject.rb
+- lib/rubocop/zuno/plugin.rb
 - lib/rubocop/zuno/version.rb
 - rails.yml
 - rspec.yml
@@ -146,6 +160,7 @@ homepage: https://github.com/zuno-tech/rubocop-zuno
 licenses:
 - MIT
 metadata:
+  default_lint_roller_plugin: RuboCop::Zuno::Plugin
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/lib/rubocop/zuno/inject.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module Zuno
-    # 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).tap(&:make_excludes_absolute)
-
-        # Using Rails.logger here will cause an error.
-        # See https://github.com/zuno-tech/rubocop-zuno/pull/187
-        # rubocop:disable Rails/Output
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        # rubocop:enable Rails/Output
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end