rubocop-extension-generator 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9817fe0f1ec5cb61766b2cb585c374339cad9c6cb90d3c2be5f432e9b9bb5dea
-  data.tar.gz: 7158dde99e78d20b70ecc796e6334b7db50ed11a00f8fffea44f56ba4d4b4716
+  metadata.gz: 0c0f67a779d53faf1f517f4479848dab47a1f2d64e6d26caae1f273ee3b914ad
+  data.tar.gz: a8bbd3a759b3acec39b598bc4d873f507546e5dfe13928e700d777925a6a6a09
 SHA512:
-  metadata.gz: 24a44f37e06a8ae312bc67e20b31a232571388a133b58943f03967c6f4d1fb243a53c0ec0ee913585c43465cd5127eca959bf852ea1c8273ba7231022e38f32a
-  data.tar.gz: 58e05d81e271e00d7d18f199ae4a283671a263e557552e279565c15f70634819646fbdd1d78ad416694c294ae1c615056a53ca729dd1dd71864a92cf0a38519a
+  metadata.gz: 9b0a678228716c9a05c9b4a8878dc25007d2cc1aac63e82549658ef119436be795fd6438bc8fbd4f8202ca01534ea0a4ee2d5948d36f2c4f10b5c2c42524389b
+  data.tar.gz: a5d2e5c95b9fba2d955c8be74e669cc1c90d8c989d7ba5a684ac466a13d2693f2e93e266bc7e504ab54ae8aac5e0f6582a69607d84dd2624ba2ec4ae8d521a80

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # master (unreleased)
 
+## v0.6.1
+
+* [#28](https://github.com/rubocop/rubocop-extension-generator/pull/28): Prevent errors when internally using cops that rely on configuration options.
+
+## v0.6.0
+
+* [#27](https://github.com/rubocop/rubocop-extension-generator/pull/27): Support RuboCop extension plugin.
+
 ## v0.5.2
 
 * [#19](https://github.com/rubocop/rubocop-extension-generator/pull/19): Support `bundle gem` gem name placeholder.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in rubocop-extension-generator.gemspec

data/README.md

@@ -26,27 +26,32 @@ Creating gem 'rubocop-foobar'...
       create  rubocop-foobar/Gemfile
       create  rubocop-foobar/lib/rubocop/foobar.rb
       create  rubocop-foobar/lib/rubocop/foobar/version.rb
+      create  rubocop-foobar/sig/rubocop/foobar.rbs
       create  rubocop-foobar/rubocop-foobar.gemspec
       create  rubocop-foobar/Rakefile
       create  rubocop-foobar/README.md
       create  rubocop-foobar/bin/console
       create  rubocop-foobar/bin/setup
       create  rubocop-foobar/.gitignore
-Initializing git repo in /tmp/tmp.Gu7G94wX00/rubocop-foobar
+      create  rubocop-foobar/LICENSE.txt
 Gem 'rubocop-foobar' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html
 create rubocop-foobar/lib/rubocop-foobar.rb
-create rubocop-foobar/lib/rubocop/foobar/inject.rb
+create rubocop-foobar/lib/rubocop/foobar/plugin.rb
 create rubocop-foobar/lib/rubocop/cop/foobar_cops.rb
 create rubocop-foobar/config/default.yml
 create rubocop-foobar/spec/spec_helper.rb
 create rubocop-foobar/.rspec
-update lib/rubocop/foobar.rb
+create rubocop-foobar/.rubocop.yml
 update lib/rubocop/foobar.rb
 update lib/rubocop/foobar/version.rb
+update README.md
+update rubocop-foobar.gemspec
 update rubocop-foobar.gemspec
 update rubocop-foobar.gemspec
 update Rakefile
 update Gemfile
+update README.md
+delete sig
 
 It's done! You can start developing a new extension of RuboCop in rubocop-foobar.
 For the next step, you can use the cop generator.
@@ -67,4 +72,3 @@ You can execute a smoke test with `ruby smoke/smoke.rb`. Check it is success bef
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop/rubocop-extension-generator.
-

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 task :default => :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "rubocop/extension/generator"

data/exe/rubocop-extension-generator

@@ -1,4 +1,5 @@
 #!ruby
+# frozen_string_literal: true
 
 require 'rubocop/extension/generator'
 

data/lib/rubocop/extension/generator/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Extension
     module Generator

data/lib/rubocop/extension/generator/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Extension
     module Generator
@@ -16,30 +18,39 @@ module RuboCop
 
             require_relative '#{dirname}'
             require_relative '#{dirname}/version'
-            require_relative '#{dirname}/inject'
-
-            RuboCop::#{classname}::Inject.defaults!
+            require_relative '#{dirname}/plugin'
 
-            require_relative '#{cops_file_name.sub(/\.rb$/, '').sub(/^lib\//, '')}'
+            require_relative '#{cops_file_name.sub(/\.rb$/, '').sub(%r{^lib/}, '')}'
           RUBY
 
-          put "lib/#{dirname}/inject.rb", <<~RUBY
+          put "lib/#{dirname}/plugin.rb", <<~RUBY
             # 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
+            require 'lint_roller'
+
             module RuboCop
               module #{classname}
-                # 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)
+                # A plugin that integrates #{name} with RuboCop's plugin system.
+                class Plugin < LintRoller::Plugin
+                  def about
+                    LintRoller::About.new(
+                      name: '#{name}',
+                      version: VERSION,
+                      homepage: "TODO: Put your plugin's homepage URL here.",
+                      description: "TODO: Put your plugin's description here."
+                    )
+                  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
@@ -61,8 +72,6 @@ module RuboCop
             require 'rubocop/rspec/support'
 
             RSpec.configure do |config|
-              config.include RuboCop::RSpec::ExpectOffense
-
               config.disable_monkey_patching!
               config.raise_errors_for_deprecations!
               config.raise_on_warning = true
@@ -80,28 +89,26 @@ module RuboCop
           TEXT
 
           put '.rubocop.yml', <<~YML
+            plugins:
+              - rubocop-internal_affairs
+              - #{name}
+
             Naming/FileName:
-             Exclude:
-               - lib/#{name}.rb
+              Exclude:
+                - lib/#{name}.rb
           YML
 
-          patch "lib/#{dirname}.rb", /^  end\nend/, <<~RUBY
-                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
-          RUBY
-
           patch "lib/#{dirname}.rb", 'module Rubocop', 'module RuboCop'
           patch "lib/#{dirname}/version.rb", 'module Rubocop', 'module RuboCop'
+          patch 'README.md', 'Rubocop', 'RuboCop'
           patch "#{name}.gemspec", 'Rubocop', 'RuboCop'
-
+          patch "#{name}.gemspec", /required_ruby_version = ">= \d.\d.\d"/, 'required_ruby_version = ">= 2.7.0"'
           patch "#{name}.gemspec", /^end/, <<~RUBY
 
-              spec.add_runtime_dependency 'rubocop'
+              spec.metadata['default_lint_roller_plugin'] = 'RuboCop::#{classname}::Plugin'
+
+              spec.add_dependency 'lint_roller', '~> 1.1'
+              spec.add_dependency 'rubocop', '>= 1.72.2'
             end
           RUBY
 
@@ -134,6 +141,7 @@ module RuboCop
           RUBY
 
           patch 'Gemfile', /\z/, <<~RUBY
+            gem 'rubocop', '>= 1.72.2'
             gem 'rspec'
           RUBY
 
@@ -143,6 +151,10 @@ module RuboCop
             patch 'README.md', /^gem '#{name}'$/, "gem '#{name}', require: false"
           end
 
+          # NOTE: Since useful type definitions are usually not provided, they are not generated by default.
+          # Users can create them as needed.
+          delete "sig"
+
           puts
           puts <<~MESSAGE
             It's done! You can start developing a new extension of RuboCop in #{root_path}.
@@ -164,9 +176,16 @@ module RuboCop
           path = root_path / path
           file = path.read
           raise "Cannot apply patch for #{path} because #{pattern} is missing" unless file.match?(pattern)
+
           path.write file.sub(pattern, replacement)
         end
 
+        private def delete(path)
+          puts "delete #{path}"
+          path = root_path / path
+          FileUtils.rm_r(path)
+        end
+
         private def root_path
           @root_path ||= Pathname(name)
         end

data/lib/rubocop/extension/generator/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Extension
     module Generator
-      VERSION = "0.5.2"
+      VERSION = "0.6.1"
     end
   end
 end

data/lib/rubocop/extension/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubocop/extension/generator/version"
 require "rubocop/extension/generator/cli"
 require "rubocop/extension/generator/generator"

data/rubocop-extension-generator.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/rubocop/extension/generator/version'
 
 Gem::Specification.new do |spec|
@@ -9,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A generator of RuboCop's custom cops gem}
   spec.description   = %q{A generator of RuboCop's custom cops gem}
   spec.homepage      = "https://github.com/rubocop/rubocop-extension-generator"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
   spec.licenses = ['MIT']
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
@@ -27,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rubocop', '>= 1.22.0'
+  spec.add_runtime_dependency 'rubocop', '>= 1.72.2'
   spec.add_runtime_dependency 'bundler'
   spec.add_runtime_dependency 'activesupport'
 end

data/smoke/smoke.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Smoke testing for this gem
 
 require 'tmpdir'
@@ -18,11 +20,12 @@ Dir.mktmpdir('-rubocop-extension-generator-smoke') do |base_dir|
   gemspec[/spec\.summary.+/] = 'spec.summary = "a gem for smoke testing"'
   gemspec.gsub!(/^.+spec\.description.+$/, '')
   gemspec.gsub!(/^.+spec\.homepage.+$/, '')
-  gemspec.gsub!(/^.+spec\.metadata.+$/, '')
+  gemspec.gsub!(/^.+spec\.metadata\["(homepage_uri|source_code_uri|changelog_uri)"\].+$/, '')
 
   gemspec_path.write gemspec
 
   system('bundle', 'install', exception: true, chdir: gem_dir)
   system('bundle', 'exec', 'rake', 'new_cop[Smoke/Foo]', exception: true, chdir: gem_dir)
+  system('bundle', 'exec', 'rubocop', '-a', exception: true, chdir: gem_dir)
   system('bundle', 'exec', 'rake', 'spec', exception: true, chdir: gem_dir)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-extension-generator
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.72.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 1.72.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: A generator of RuboCop's custom cops gem