rubocop-faker 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e905846c9989294b1dfd34c9ebf8224d319476103bed10f3aa939c2b242739b3
-  data.tar.gz: 0d4e63a90bf719a39380830d716097f90acefeb63149bf2f3f870ad0aa82d45a
+  metadata.gz: 9411434bc51ae4bd5aeb3ec021d79472ac55c39d8fd96785d46094ada5380049
+  data.tar.gz: a53752635232f959e334ed106edbb0c4b7dcb3f76cc0958c39b2380971fb9388
 SHA512:
-  metadata.gz: ed10d5471a325618fb0c8f5ce32e5c193a5e683b12e673f7bbb19e3c47870c34e79d6a1aa6748a5568963a4d94d1be063379fbba6036115a1707f0fcb404d4f4
-  data.tar.gz: bdcbc64672f446a338a7848cf400618646fdcfcf573c786255feb6afbab999b8af38962b62c278e313668ffc65d3669194f285cd772f0fb8844e47c3c2f516b7
+  metadata.gz: e7c01bad74e1fb97f64e254d39858289ec5ba710460662d6e06e7e5baac4ff569c9a382ee24c426031489b3a291267c5b7229165f3483c342da274aacf282d02
+  data.tar.gz: 55ab7dad2875123dcdd9d5cd7b6257fc69b3ac11d1739ca91453ec53f7693d66a9a404d896394f15fb308f7c20f91241205e1025c883563a2dff8a61bf2dfa83

data/.circleci/config.yml

@@ -24,20 +24,20 @@ workflows:
   build:
     jobs:
       - rake_default:
-          name: Ruby 2.4
-          image: circleci/ruby:2.4
+          name: Ruby 2.7
+          image: cimg/ruby:2.7
       - rake_default:
-          name: Ruby 2.5
-          image: circleci/ruby:2.5
+          name: Ruby 3.0
+          image: cimg/ruby:3.0
       - rake_default:
-          name: Ruby 2.6
-          image: circleci/ruby:2.6
+          name: Ruby 3.1
+          image: cimg/ruby:3.1
       - rake_default:
-          name: Ruby 2.7
-          image: circleci/ruby:2.7
+          name: Ruby 3.2
+          image: cimg/ruby:3.2
+      - rake_default:
+          name: Ruby 3.3
+          image: cimg/ruby:3.3
       - rake_default:
           name: Ruby HEAD
           image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build
-      - rake_default:
-          name: JRuby 9.2
-          image: circleci/jruby:9.2

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: koic

data/.rubocop.yml

@@ -2,13 +2,14 @@ inherit_from: .rubocop_todo.yml
 
 # This is the configuration used to check the rubocop source code.
 
-require:
-  - rubocop/cop/internal_affairs
+plugins:
+  - rubocop-internal_affairs
   - rubocop-performance
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
 
 Naming/PredicateName:
   # Method define macros for dynamically generated method.
@@ -83,3 +84,6 @@ Metrics/ModuleLength:
 
 Performance/ChainArrayAllocation:
   Enabled: false
+
+InternalAffairs/UndefinedConfig:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## master (unreleased)
 
+## 1.3.0 (2025-02-18)
+
+### New features
+
+* Pluginfy RuboCop Faker. ([@koic][])
+* Support safe navigation operator for `Faker/DeprecatedArguments`. ([@koic][])
+
+## 1.2.0 (2024-10-22)
+
+### Bug fixes
+
+* [#7](https://github.com/koic/rubocop-faker/issues/7): Suppress RuboCop's deprecation warning. ([@koic][])
+
+### Changes
+
+* Drop support for Ruby 2.6 and lower. ([@koic][])
+
 ## 1.1.0 (2020-06-11)
 
 ### Bug fixes

data/Gemfile

@@ -8,8 +8,8 @@ gemspec
 
 gem 'rake'
 gem 'rspec'
-gem 'rubocop', github: 'rubocop-hq/rubocop'
-gem 'rubocop-performance', '~> 1.5.0'
+gem 'rubocop', github: 'rubocop/rubocop'
+gem 'rubocop-performance', '~> 1.24.0'
 # Workaround for YARD 0.9.20 or lower.
 # It specifies `github` until the release that includes the following changes:
 # https://github.com/lsegal/yard/pull/1290

data/README.md

@@ -48,15 +48,28 @@ This gem offers the only `Faker/DeprecatedArguments` cop. It is intended to conv
 Check positional argument style before Faker 2.
 
 ```console
-% rubocop --require rubocop-faker --only Faker/DeprecatedArguments
+% rubocop --plugin rubocop-faker --only Faker/DeprecatedArguments
 ```
 
 Auto-correction to keyword argument style on Faker 2.
 
 ```console
-% rubocop --require rubocop-faker --only Faker/DeprecatedArguments --auto-correct
+% rubocop --plugin rubocop-faker --only Faker/DeprecatedArguments --autocorrect
 ```
 
+### RuboCop configuration file
+
+Add `rubocop-faker` to required extension.
+
+```yaml
+# .rubocop.yml
+plugins:
+  - rubocop-faker
+```
+
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/koic/rubocop-faker.

data/lib/rubocop/cop/faker/deprecated_arguments.rb

@@ -3,7 +3,6 @@
 module RuboCop
   module Cop
     module Faker
-      #
       # Checks that Faker arguments style is based on Faker 2.
       # Use keyword arguments instead of positional arguments.
       #
@@ -14,8 +13,9 @@ module RuboCop
       #   # good
       #   Avatar.image(slug: slug, size: size, format: format)
       #
-      class DeprecatedArguments < Cop
+      class DeprecatedArguments < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Passing `%<arg>s` with the %<index>s argument of ' \
               '`%<class_name>s.%<method_name>s` is deprecated. ' \
@@ -45,22 +45,12 @@ module RuboCop
             add_offense_for_arguments(node, argument, message)
           end
         end
-
-        def autocorrect(node)
-          methods = argument_keywords[faker_class_name(node)]
-          keywords = methods[node.method_name.to_s]
-
-          kwargs = build_kwargs_style(node, keywords)
-
-          lambda do |corrector|
-            corrector.replace(arguments_range(node), kwargs)
-          end
-        end
+        alias on_csend on_send
 
         private
 
         def unique_generator_method?(node)
-          node.method?(:unique) && node.arguments.size.zero?
+          node.method?(:unique) && node.arguments.empty?
         end
 
         def format_message(keyword:, arg:, index:, class_name:, method_name:)
@@ -82,10 +72,20 @@ module RuboCop
 
         def add_offense_for_arguments(node, argument, message)
           add_offense(
-            node,
-            location: argument.source_range,
+            argument,
             message: message
-          )
+          ) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        def autocorrect(corrector, node)
+          methods = argument_keywords[faker_class_name(node)]
+          keywords = methods[node.method_name.to_s]
+
+          kwargs = build_kwargs_style(node, keywords)
+
+          corrector.replace(arguments_range(node), kwargs)
         end
 
         def build_kwargs_style(node, keywords)

data/lib/rubocop/faker/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Faker
+    # A plugin that integrates RuboCop Faker with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-faker',
+          version: VERSION,
+          homepage: 'https://github.com/koic/rubocop-faker',
+          description: 'A RuboCop extension for Faker.'
+        )
+      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/faker/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Faker
-    VERSION = '1.1.0'
+    VERSION = '1.3.0'
   end
 end

data/lib/rubocop/faker.rb

@@ -1,12 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  # RuboCop Faker project namespace
+  # RuboCop Faker project namespace.
   module Faker
-    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-faker.rb

@@ -4,8 +4,5 @@ require 'rubocop'
 
 require_relative 'rubocop/faker'
 require_relative 'rubocop/faker/version'
-require_relative 'rubocop/faker/inject'
-
-RuboCop::Faker::Inject.defaults!
-
+require_relative 'rubocop/faker/plugin'
 require_relative 'rubocop/cop/faker_cops'

data/rubocop-faker.gemspec

@@ -12,9 +12,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'A RuboCop extension for Faker.'
   spec.homepage      = 'https://github.com/koic/rubocop-faker'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
-  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'rubygems_mfa_required' => 'true',
+    'default_lint_roller_plugin' => 'RuboCop::Faker::Plugin'
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,6 +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 'faker', '>= 2.12.0'
-  spec.add_runtime_dependency 'rubocop', '>= 0.82.0'
+  spec.add_dependency 'faker', '>= 2.12.0'
+  spec.add_dependency 'lint_roller', '~> 1.1'
+  spec.add_dependency 'rubocop', '>= 1.72.1'
 end

data/tasks/cops_documentation.rake

@@ -40,7 +40,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     ]
     config = config.for_cop(cop)
     safe_auto_correct = config.fetch('SafeAutoCorrect', true)
-    autocorrect = if cop.new.support_autocorrect?
+    autocorrect = if cop.support_autocorrect?
                     "Yes #{'(Unsafe)' unless safe_auto_correct}"
                   else
                     'No'
@@ -52,7 +52,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       config.fetch('VersionAdded', '-'),
       config.fetch('VersionChanged', '-')
     ]]
-    to_table(header, content) + "\n"
+    "#{to_table(header, content)}\n"
   end
   # rubocop:enable Metrics/MethodLength
 
@@ -131,7 +131,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       Array.new(header.size, '---').join(' | ')
     ]
     table.concat(content.map { |c| c.join(' | ') })
-    table.join("\n") + "\n"
+    "#{table.join("\n")}\n"
   end
 
   def format_table_value(val)
@@ -175,7 +175,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     file_name = "#{Dir.pwd}/manual/cops_#{department.downcase}.md"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
-      file.write(content.strip + "\n")
+      file.write("#{content.strip}\n")
     end
   end
 
@@ -203,7 +203,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     end
     return if selected_cops.empty?
 
-    type_title = department[0].upcase + department[1..-1]
+    type_title = department[0].upcase + department[1..]
     filename = "cops_#{department.downcase}.md"
     content = +"#### Department [#{type_title}](#{filename})\n\n"
     selected_cops.each do |cop|
@@ -223,13 +223,11 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
     content << "\n<!-- END_COP_LIST -->"
 
-    content = if original.empty?
-                content
-              else
-                original.sub(
-                  /<!-- START_COP_LIST -->.+<!-- END_COP_LIST -->/m, content
-                )
-              end
+    unless original.empty?
+      content = original.sub(
+        /<!-- START_COP_LIST -->.+<!-- END_COP_LIST -->/m, content
+      )
+    end
     File.write(path, content)
   end
 
@@ -238,8 +236,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       .departments
       .map(&:to_s)
       .sort
-      .map { |department| table_of_content_for_department(cops, department) }
-      .reject(&:nil?)
+      .filter_map { |department| table_of_content_for_department(cops, department) }
       .join("\n")
   end
 
@@ -252,13 +249,13 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       sh('GIT_PAGER=cat git diff manual')
 
       warn 'The manual directory is out of sync. ' \
-        'Run `rake generate_cops_documentation` and commit the results.'
+           'Run `rake generate_cops_documentation` and commit the results.'
       exit!
     end
   end
 
   def main
-    cops   = RuboCop::Cop::Cop.registry
+    cops   = RuboCop::Cop::Registry.global
     config = RuboCop::ConfigLoader.load_file('config/default.yml')
 
     YARD::Registry.load!
@@ -282,7 +279,7 @@ task documentation_syntax_check: :yard_for_generate_documentation do
 
   ok = true
   YARD::Registry.load!
-  cops = RuboCop::Cop::Cop.registry
+  cops = RuboCop::Cop::Registry.global
   cops.each do |cop|
     examples = YARD::Registry.all(:class).find do |code_object|
       next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
@@ -291,17 +288,15 @@ task documentation_syntax_check: :yard_for_generate_documentation do
     end
 
     examples.to_a.each do |example|
-      begin
-        buffer = Parser::Source::Buffer.new('<code>', 1)
-        buffer.source = example.text
-        parser = Parser::Ruby25.new(RuboCop::AST::Builder.new)
-        parser.diagnostics.all_errors_are_fatal = true
-        parser.parse(buffer)
-      rescue Parser::SyntaxError => e
-        path = example.object.file
-        puts "#{path}: Syntax Error in an example. #{e}"
-        ok = false
-      end
+      buffer = Parser::Source::Buffer.new('<code>', 1)
+      buffer.source = example.text
+      parser = Parser::Ruby25.new(RuboCop::AST::Builder.new)
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.parse(buffer)
+    rescue Parser::SyntaxError => e
+      path = example.object.file
+      puts "#{path}: Syntax Error in an example. #{e}"
+      ok = false
     end
   end
   abort unless ok

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-faker
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Koichi ITO
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !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: 0.82.0
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 1.72.1
 description: A RuboCop extension for Faker.
 email:
 - koic.ito@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -62,7 +77,7 @@ files:
 - lib/rubocop/cop/faker/deprecated_arguments.rb
 - lib/rubocop/cop/faker_cops.rb
 - lib/rubocop/faker.rb
-- lib/rubocop/faker/inject.rb
+- lib/rubocop/faker/plugin.rb
 - lib/rubocop/faker/version.rb
 - manual/cops.md
 - manual/cops_faker.md
@@ -73,7 +88,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/koic/rubocop-faker
-post_install_message: 
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Faker::Plugin
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +98,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.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A RuboCop extension for Faker.
 test_files: []

data/lib/rubocop/faker/inject.rb

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