rubocop-numbered-params 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6736396b22b8136265688409f5eedf51499d99c5ef1d99a40dfd8586f383073
+  data.tar.gz: 9419b0424fe92cd303431ff7504840cbce5d7c3b7622a6ea08f8d5a28bf73a98
+SHA512:
+  metadata.gz: d0275feb564c675a59df04a64c6a0302b1ec8c80df289538061d85796c59f36b4fb784404459149c5842d482fdde7dca78c8a687e75ad25335d209e486f107e5
+  data.tar.gz: 6a97e1375d9432a61128490604886955e8c37319535fe652ac0d7ffd05adfab87490f1fb109d90b349d1008278779058139cb5d4ca31eab52ab6118eecf47075

data/.claude/hooks/session-start.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -euo pipefail
+
+# Only run in Claude Code on the web (remote environment)
+if [ "${CLAUDE_CODE_REMOTE:-}" != "true" ]; then
+  exit 0
+fi
+
+# Bundler 4.0 + Ruby 3.3 compatibility workaround:
+# Bundler 4.0's vendored net-http-persistent uses CGI.unescape which
+# references @@accept_charset before it's initialized in Ruby 3.3.
+# Pre-loading the CGI library via RUBYOPT resolves this.
+echo 'export RUBYOPT="-rcgi"' >> "$CLAUDE_ENV_FILE"
+
+RUBYOPT="-rcgi" bundle install

data/.claude/settings.json

@@ -0,0 +1,14 @@
+{
+  "hooks": {
+    "SessionStart": [
+      {
+        "hooks": [
+          {
+            "type": "command",
+            "command": "$CLAUDE_PROJECT_DIR/.claude/hooks/session-start.sh"
+          }
+        ]
+      }
+    ]
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-02-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"rubocop-numbered-params" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["i.tkomiya@gmail.com"](mailto:"i.tkomiya@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Takeshi KOMIYA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Rubocop::Numbered::Params
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/numbered/params`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-numbered-params. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-numbered-params/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Numbered::Params project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-numbered-params/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,5 @@
+Style/PreferNumberedParameter:
+  Description: 'Prefer numbered parameters (`_1`, `_2`) for single-line blocks.'
+  Enabled: true
+  VersionAdded: '1.0'
+  MaxArguments: 1

data/lib/rubocop/cop/style/prefer_numbered_parameter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Recommends using numbered parameters (`_1`, `_2`) instead of
+      # named block arguments in single-line blocks with few arguments.
+      #
+      # @example
+      #   # bad
+      #   users.map { |user| user.name }
+      #   items.select { |item| item.active? }
+      #
+      #   # good
+      #   users.map { _1.name }
+      #   items.select { _1.active? }
+      #
+      #   # good - multi-line block (not targeted)
+      #   users.map do |user|
+      #     user.name
+      #   end
+      #
+      # @example MaxArguments: 2
+      #   # bad
+      #   hash.each { |key, value| "#{key}: #{value}" }
+      #
+      #   # good
+      #   hash.each { "#{_1}: #{_2}" }
+      #
+      class PreferNumberedParameter < Base
+        extend AutoCorrector
+
+        MSG = "Use numbered parameters (`_1`, `_2`, ...) instead of named block arguments " \
+              "for single-line blocks."
+
+        def on_block(node)
+          return unless node.single_line?
+          return if node.arguments.empty?
+          return if node.arguments.count > max_arguments
+          return if node.body.nil?
+          return if special_arguments?(node)
+          return if contains_inner_block?(node.body)
+
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node) # rubocop:disable Metrics/AbcSize
+          lvar_nodes = collect_lvar_nodes(node.body)
+
+          node.arguments.each.with_index(1) do |arg, index|
+            numbered = "_#{index}"
+            lvar_nodes.select { _1.children.first == arg.name }.each do |lvar|
+              corrector.replace(lvar.source_range, numbered)
+            end
+          end
+
+          args_range = node.arguments.source_range
+          corrector.remove(args_range.resize(args_range.size + 1))
+        end
+
+        def collect_lvar_nodes(node)
+          result = []
+          result << node if node.lvar_type?
+          node.each_descendant(:lvar) { result << _1 }
+          result
+        end
+
+        def max_arguments
+          cop_config.fetch("MaxArguments", 1)
+        end
+
+        def special_arguments?(node)
+          node.arguments.any? do |arg|
+            arg.mlhs_type? || arg.restarg_type? || arg.blockarg_type? || arg.shadowarg_type?
+          end
+        end
+
+        def contains_inner_block?(node)
+          return false unless node
+
+          node.block_type? || node.numblock_type? || node.each_descendant(:block, :numblock).any?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/numbered/params/plugin.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module Rubocop
+  module Numbered
+    module Params
+      class Plugin < LintRoller::Plugin
+        def about
+          LintRoller::About.new(
+            name: "rubocop-numbered-params",
+            version: VERSION,
+            homepage: "https://github.com/tk0miya/rubocop-numbered-params",
+            description: "A RuboCop plugin that recommends using numbered parameters (_1, _2) " \
+                         "instead of named block arguments in short blocks."
+          )
+        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
+end

data/lib/rubocop/numbered/params/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Numbered
+    module Params
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/rubocop/numbered/params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "params/version"
+require_relative "params/plugin"
+require_relative "../cop/style/prefer_numbered_parameter"
+
+module Rubocop
+  module Numbered
+    module Params
+      class Error < StandardError; end
+    end
+  end
+end

data/sig/rubocop/numbered/params.rbs

@@ -0,0 +1,8 @@
+module Rubocop
+  module Numbered
+    module Params
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-numbered-params
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Takeshi KOMIYA
+bindir: exe
+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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: A RuboCop plugin to lint numbered parameters
+email:
+- i.tkomiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".claude/hooks/session-start.sh"
+- ".claude/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop/cop/style/prefer_numbered_parameter.rb
+- lib/rubocop/numbered/params.rb
+- lib/rubocop/numbered/params/plugin.rb
+- lib/rubocop/numbered/params/version.rb
+- sig/rubocop/numbered/params.rbs
+homepage: https://github.com/tk0miya/rubocop-numbered-params
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/tk0miya/rubocop-numbered-params
+  source_code_uri: https://github.com/tk0miya/rubocop-numbered-params
+  changelog_uri: https://github.com/tk0miya/rubocop-numbered-params/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: Rubocop::Numbered::Params::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A RuboCop plugin to lint numbered parameters
+test_files: []