rubocop-packaging 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 666f4f441549972df8c21db0c0a8c0029849da018dc71c9ca17d3c54ba532d4b
-  data.tar.gz: 0f2d7234dfd13bffdecdbd965998eabef9e38344c441dae94389289748258d98
+  metadata.gz: 6565506bee250845cebad398a71ebbbaaf098fcfe8e233b9f5ce4a917ea77e90
+  data.tar.gz: da4d689b1d31c3848cdc1fa0215f83ca5d30df069ec2b673b096acc03f1ea40d
 SHA512:
-  metadata.gz: 575ca964189b75c0d20fb0967139f56fa11720236f7c5708949f8264048450ea564ac5e501d71058da813ed569379cfdc23317d727aed7a5ab8ba488276e2556
-  data.tar.gz: 0afd0fe1a56716a5cb5d56f6bc3aeb02faff140e8229f759cea96e1133d65b31361a364f64d9262497d7253d06459ee438b0f58206d901eac038281ff41e33c8
+  metadata.gz: e7b32669885afb6c10df34e5b0dfac80475fa577997d89b8552889b85b797d3b1b8d254761d8c04d69efbbd32de54d34d1ed52da3b8a07eacfc5dffa152233b2
+  data.tar.gz: e259c5354b6ef3ae14b8f7f3f17c24973d793b31a9b0c325b3ddddeaa31697f11c903d39287b0c85d6ecf4fa7e6dcffc47b8e0b8d21a6266d1d70b27a57e68a6

data/README.md

@@ -48,14 +48,14 @@ ways to do this:
 Put this into your `.rubocop.yml` file:
 
 ```yaml
-require: rubocop-packaging
+plugins: rubocop-packaging
 ```
 
 Alternatively, use the following array notation when specifying multiple
 extensions:
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-packaging
 ```
@@ -63,17 +63,20 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Packaging
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-packaging
+rubocop --plugin rubocop-packaging
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-packaging'
+  task.plugins << 'rubocop-packaging'
 end
 ```
 
@@ -87,7 +90,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-As always, bug reports and pull requests are heartily welcomed! 💖  
+As always, bug reports and pull requests are heartily welcomed! 💖
 This project is intended to be a safe and welcoming space for collaboration.
 
 ## License

data/config/default.yml

@@ -1,5 +1,9 @@
 # This is the default configuration file.
 
+Packaging:
+  Enabled: true
+  DocumentationBaseURL: https://docs.rubocop.org/rubocop-packaging
+
 Packaging/BundlerSetupInTests:
   Description: >-
                  Using `bundler/setup` in tests is redundant. Consider

data/lib/rubocop/cop/packaging/gemspec_git.rb

@@ -11,14 +11,12 @@ module RuboCop # :nodoc:
       #
       #   # bad
       #   Gem::Specification.new do |spec|
-      #     spec.files         = `git ls-files`.split("\n")
-      #     spec.test_files    = `git ls-files -- spec`.split("\n")
+      #     spec.files = `git ls-files`.split("\n")
       #   end
       #
       #   # good
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Dir["lib/**/*", "LICENSE", "README.md"]
-      #     spec.test_files    = Dir["spec/**/*"]
+      #     spec.files = Dir["lib/**/*", "LICENSE", "README.md"]
       #   end
       #
       #   # bad
@@ -32,21 +30,19 @@ module RuboCop # :nodoc:
       #   require "rake/file_list"
       #
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Rake::FileList["**/*"].exclude(*File.read(".gitignore").split)
+      #     spec.files = Rake::FileList["**/*"].exclude(*File.read(".gitignore").split)
       #   end
       #
       #   # bad
       #   Gem::Specification.new do |spec|
-      #     spec.files         = `git ls-files -- lib/`.split("\n")
-      #     spec.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
-      #     spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+      #     spec.files        = `git ls-files -- lib/`.split("\n")
+      #     spec.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
       #   end
       #
       #   # good
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Dir.glob("lib/**/*")
-      #     spec.test_files    = Dir.glob("test/{functional,test}/*")
-      #     spec.executables   = Dir.glob("bin/*").map{ |f| File.basename(f) }
+      #     spec.files        = Dir.glob("lib/**/*")
+      #     spec.executables  = Dir.glob("bin/*").map{ |f| File.basename(f) }
       #   end
       #
       class GemspecGit < Base

data/lib/rubocop/packaging/lib_helper_module.rb

@@ -7,7 +7,7 @@ module RuboCop # :nodoc:
     module LibHelperModule
       # For determining the root directory of the project.
       def root_dir
-        RuboCop::ConfigLoader.project_root
+        RuboCop::ConfigFinder.project_root
       end
 
       # This method determines if the calls are made to the "lib" directory.

data/lib/rubocop/packaging/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Packaging
+    # A plugin that integrates RuboCop Packaging with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-packaging",
+          version: VERSION,
+          homepage: "https://github.com/utkarsh2102/rubocop-packaging",
+          description: "A collection of RuboCop cops to check for downstream compatibility issues in the Ruby code."
+        )
+      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/packaging/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Packaging
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

data/lib/rubocop/packaging.rb

@@ -5,10 +5,5 @@ require "rubocop/packaging/version"
 module RuboCop
   # RuboCop Packaging project namespace
   module Packaging
-    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

data/lib/rubocop-packaging.rb

@@ -4,8 +4,5 @@ require "rubocop"
 
 require_relative "rubocop/packaging"
 require_relative "rubocop/packaging/version"
-require_relative "rubocop/packaging/inject"
-
-RuboCop::Packaging::Inject.defaults!
-
+require_relative "rubocop/packaging/plugin"
 require_relative "rubocop/cop/packaging_cops"

metadata

@@ -1,43 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packaging
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Utkarsh Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
+        version: 1.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,28 +100,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.89'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.89'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: |
-  A collection of RuboCop cops to check for downstream compatability issues in the
+  A collection of RuboCop cops to check for downstream compatibility issues in the
   Ruby code.
 email:
 - utkarsh@debian.org
@@ -119,8 +119,8 @@ files:
 - lib/rubocop/cop/packaging/require_relative_hardcoding_lib.rb
 - lib/rubocop/cop/packaging_cops.rb
 - lib/rubocop/packaging.rb
-- lib/rubocop/packaging/inject.rb
 - lib/rubocop/packaging/lib_helper_module.rb
+- lib/rubocop/packaging/plugin.rb
 - lib/rubocop/packaging/version.rb
 homepage: https://github.com/utkarsh2102/rubocop-packaging
 licenses:
@@ -128,6 +128,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/utkarsh2102/rubocop-packaging
   source_code_uri: https://github.com/utkarsh2102/rubocop-packaging
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Packaging::Plugin
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -136,15 +138,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: Automatic downstream compatability checking tool for Ruby code
+summary: Automatic downstream compatibility checking tool for Ruby code
 test_files: []

data/lib/rubocop/packaging/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Packaging
-    # 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)
-        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