rubocop-i18n 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8757409734d4423d1eadc150b14ab3ea6d9ba9a0063dc9dd47de719e22ba5f3
-  data.tar.gz: 52a3962588122fbc261b91ab8a55b038640f169349d93e7f8ccf8e44dd4ec5ab
+  metadata.gz: fda7be0dbfbfc1501a16330bb1e4cc629a91d9f3a87635ea563e161e9fa66c97
+  data.tar.gz: 7919994e5321618fe590f699c39f0056bdba4ba8269d89fe6be91548a5ec5404
 SHA512:
-  metadata.gz: aeb2ba4d3bd6cc24d9f88ad0c74e910d0a2b6ab20328d890538f6b60451b0c6e1c92641726b925a6720beddff082e766cbd7a6d30881ad1078d2004b6b077346
-  data.tar.gz: a61d551a0ee9bb628c10b3e57b2ab8efffb84dcae53939203b9257fb6a92e4c1470df0348654382bbf788b238461ff7ff8f437108cb568644db5dc333af3ad71
+  metadata.gz: 119d18b16d3dec2a93a84861516f8ca4f79e1878cf71e63a400c9c24e9eb9da0579fc8c0b61963a0285e4509874ca5ffe51942f8dc95acb3b920b0f830176c34
+  data.tar.gz: 32115fb43cadb384bceeff872b5640a70641e8da497ac189a6ccfd8c567cd9966dfd3e90b9548b31e2e9d681d709ce3ba68d21c8ce9384890c6171b68f6d98a6

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,9 +8,11 @@ assignees: ''
 ---
 
 **Describe the bug**
+
 A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
@@ -18,21 +20,39 @@ Steps to reproduce the behavior:
 4. See error
 
 **Expected behavior**
+
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
+
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
+
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
+
  - Device: [e.g. iPhone6]
  - OS: [e.g. iOS8.1]
  - Browser [e.g. stock browser, safari]
  - Version [e.g. 22]
 
 **Additional context**
+
 Add any other context about the problem here.
+
+**RuboCop version**
+
+Include the output of `rubocop -V` or `bundle exec rubocop -V` if using Bundler.
+If you see extension cop versions (e.g. `rubocop-performance`, `rubocop-rspec`, and others)
+output by `rubocop -V`, include them as well. Here's an example:
+
+```console
+$ [bundle exec] rubocop -V
+1.73.1 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 3.3, running on ruby 3.3.5) [x86_64-linux]
+  - rubocop-performance 1.22.1
+  - rubocop-rspec 3.1.0
+```

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.ruby-version
 /.config
 /coverage/
 /InstalledFiles
@@ -10,6 +11,7 @@
 /test/version_tmp/
 /tmp/
 /.idea/
+Gemfile.lock
 
 # Used by dotenv library to load environment variables.
 # .env

data/.rubocop.yml

@@ -1,12 +1,13 @@
 inherit_from: .rubocop_todo.yml
-require:
-  - rubocop/cop/internal_affairs
+
+plugins:
+  - rubocop-internal_affairs
   - rubocop-rake
   - rubocop-rspec
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 # rubocop-i18n does not have config/default.

data/.rubocop_todo.yml

@@ -1,11 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-15 21:44:52 UTC using RuboCop version 1.70.0.
+# on 2025-01-23 02:17:39 UTC using RuboCop version 1.71.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 4
+InternalAffairs/OnSendWithoutOnCSend:
+  Exclude:
+    - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb'
+    - 'lib/rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation.rb'
+
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Lint/InterpolationCheck:

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 
-### [master (Unreleased)](https://github.com/rubocop/rubocop-i18n/compare/v3.1.0...master)
+### [master (Unreleased)](https://github.com/rubocop/rubocop-i18n/compare/v3.2.1...master)
+
+### [3.2.1](https://github.com/rubocop/rubocop-i18n/compare/v3.2.0...v3.2.1)
+
+* Make the runtime dependency on RuboCop more flexible.
+
+### [3.2.0](https://github.com/rubocop/rubocop-i18n/compare/v3.1.0...v3.2.0)
+
+* Pluginfy rubocop-i18n (#65)
 
 ### [3.1.0](https://github.com/rubocop/rubocop-i18n/compare/v3.0.0...v3.1.0)
 

data/README.md

@@ -1,6 +1,6 @@
 # Rubocop::I18n
 
-[![Build Status](https://travis-ci.com/puppetlabs/rubocop-i18n.svg?branch=master)](https://travis-ci.com/puppetlabs/rubocop-i18n)
+[![CI](https://github.com/rubocop/rubocop-i18n/actions/workflows/rubocop.yml/badge.svg)](https://github.com/rubocop/rubocop-i18n/actions/workflows/rubocop.yml)
 
 A set of cops for detecting strings that need i18n decoration in your project.
 
@@ -28,8 +28,9 @@ Or install it yourself as:
 ## Usage
 
 In your `rubocop.yml`:
-```
-require:
+
+```yaml
+plugins:
  - rubocop-i18n
 ...
 # You *must* choose GetText or Rails-i18n style checking
@@ -58,6 +59,9 @@ I18n/RailsI18n/DecorateString:
   Enabled: false
 ```
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ## Cops
 
 ### I18n/GetText/DecorateString
@@ -331,4 +335,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop/rubocop-i18n. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [The RuboCop Community Code of Conduct](CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubocop/rubocop-i18n. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [RuboCop Community Code of Conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -11,5 +11,5 @@ task test: %i[rubocop spec]
 
 desc 'Run RuboCop'
 task :rubocop do
-  sh 'rubocop -P'
+  sh 'rubocop'
 end

data/lib/rubocop/cop/i18n/gettext/decorate_string.rb

@@ -33,7 +33,7 @@ module RuboCop
 
             parent = node.parent
             if parent.respond_to?(:type)
-              return if parent.regexp_type? || parent.dstr_type?
+              return if parent.type?(:regexp, :dstr)
             end
 
             check_for_parent_decorator(node)

data/lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb

@@ -44,7 +44,7 @@ module RuboCop
           def contains_string_formatting_with_interpolation?(node)
             return node.any? { |n| contains_string_formatting_with_interpolation?(n) } if node.is_a?(Array)
 
-            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && (node.str_type? || node.dstr_type?)
+            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && node.type?(:str, :dstr)
 
             return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) } if node.respond_to?(:children)
 

data/lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb

@@ -50,7 +50,7 @@ module RuboCop
             end
 
             if node.respond_to?(:type)
-              if node.str_type? || node.dstr_type?
+              if node.type?(:str, :dstr)
                 return string_contains_percent_format?(node.source)
               end
             end

data/lib/rubocop/cop/i18n/rails_i18n/decorate_string.rb

@@ -90,7 +90,7 @@ module RuboCop
 
             parent = node.parent
             if parent.respond_to?(:type)
-              return if parent.regexp_type? || parent.dstr_type?
+              return if parent.type?(:regexp, :dstr)
             end
 
             check_for_parent_decorator(node)

data/lib/rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation.rb

@@ -48,7 +48,7 @@ module RuboCop
           def contains_string_formatting_with_interpolation?(node)
             return node.any? { |n| contains_string_formatting_with_interpolation?(n) } if node.is_a?(Array)
 
-            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && (node.str_type? || node.dstr_type?)
+            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && node.type?(:str, :dstr)
 
             return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) } if node.respond_to?(:children)
 

data/lib/rubocop/i18n/plugin.rb

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

@@ -3,9 +3,5 @@
 module RuboCop
   # RuboCop I18n project namespace
   module I18n
-    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end
 end

data/lib/rubocop-i18n.rb

@@ -3,8 +3,5 @@
 require 'rubocop'
 
 require_relative 'rubocop/i18n'
-require_relative 'rubocop/i18n/inject'
-
-RuboCop::I18n::Inject.defaults!
-
+require_relative 'rubocop/i18n/plugin'
 require_relative 'rubocop/cop/i18n_cops'

data/rubocop-i18n.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-i18n'
-  spec.version       = '3.1.0'
+  spec.version       = '3.2.1'
   spec.authors       = ['Puppet', 'Brandon High', 'TP Honey', 'Helen Campbell']
 
   spec.summary       = 'RuboCop rules for i18n'
@@ -20,11 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.8'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata = {
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'default_lint_roller_plugin' => 'RuboCop::I18n::Plugin'
   }
 
-  spec.add_dependency 'rubocop', '~> 1.0'
+  spec.add_dependency 'lint_roller', '~> 1.1'
+  spec.add_dependency 'rubocop', '>= 1.72.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Puppet
@@ -10,22 +10,36 @@ authors:
 - Helen Campbell
 bindir: exe
 cert_chain: []
-date: 2025-01-21 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.1
 description: RuboCop rules for detecting and autocorrecting undecorated strings for
   i18n (gettext and rails-i18n)
 executables: []
@@ -39,7 +53,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -60,13 +73,14 @@ files:
 - lib/rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation.rb
 - lib/rubocop/cop/i18n_cops.rb
 - lib/rubocop/i18n.rb
-- lib/rubocop/i18n/inject.rb
+- lib/rubocop/i18n/plugin.rb
 - rubocop-i18n.gemspec
 homepage: https://github.com/rubocop/rubocop-i18n
 licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::I18n::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -74,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.8
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.ruby-version

@@ -1 +0,0 @@
-3.4.1

data/lib/rubocop/i18n/inject.rb

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