rubocop-kata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afc68d8fc2ae4c367777585d33f35a3b33606f0e228a20b258f2bb3d0626b93c
+  data.tar.gz: 7ef9e559ce1dc181a714f648450ee1f8a7e38933310242020a918f37deb26101
+SHA512:
+  metadata.gz: fb1e23f94f65585d432ccae75b64637b3d4731c8296bb80e04fe6ffe6780e381f3e9d81a5523c131f8ed0c2e970e3d3022b247c224bd13aeb82fba757111d230
+  data.tar.gz: c26e89e367edbe8b36deb696232aafe1f30739abb91aa1a163fb4c56eb8b25a8b3e13a9baf83155bcb986535ffe09528eec8f57fbda23469b201b246b71494b9

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.1.0] - 2026-08-10
+
+- Initial release.
+- Cops: `Kata/AgentNoun`, `Kata/NoComments` (autocorrecting), `Kata/IoDiscipline`, `Kata/ProsePlacement`.
+- Shared defaults bundling rubocop-rspec, rubocop-performance, rubocop-elegant, rubocop-packaging, and rubocop-thread_safety.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Giacomo GK
+
+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,61 @@
+# rubocop-kata
+
+A RuboCop plugin that replaces a pile of linter gems and config with one dependency. Install it and your `.rubocop.yml` shrinks to project-specific overrides. Everything else comes from the gem: a curated stack of RuboCop extensions, opinionated style defaults, and four house cops.
+
+- **One dependency.** Bundles rubocop-rspec, rubocop-performance, rubocop-elegant, rubocop-packaging, and rubocop-thread_safety behind a single gem.
+- **Opinionated defaults.** Methods under 5 lines, classes under 100, 4 parameters max, 120-column lines, double quotes, `NewCops: enable`. See [config/default.yml](config/default.yml).
+- **Four house cops.** `Kata/AgentNoun`, `Kata/NoComments` (autocorrecting), `Kata/IoDiscipline`, `Kata/ProsePlacement`.
+
+```ruby
+class PaymentProcessor  # Kata/AgentNoun: `PaymentProcessor` names a doer;
+end                     #   name the class for the thing it is, not the work it does.
+
+class Payment           # OK
+end
+```
+
+## Getting started
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "rubocop-kata", group: :development, require: false
+```
+
+Install it and point `.rubocop.yml` at the plugin:
+
+```yaml
+plugins:
+  - rubocop-kata
+
+AllCops:
+  TargetRubyVersion: 3.4
+```
+
+```sh
+bundle install
+bundle exec rubocop
+```
+
+That's it. The plugin loads the bundled extensions and the shared defaults, so your `.rubocop.yml` keeps only what's specific to your project. Requires Ruby >= 3.4 and RuboCop ~> 1.75.
+
+## The cops
+
+| Cop | Default | What it enforces |
+| --- | --- | --- |
+| `Kata/AgentNoun` | on | Classes named for what they are, not `-er`/`-or` doers. Allow exceptions via `AllowedNames`. |
+| `Kata/NoComments` | on | No prose comments; say it in the code. Magic comments, linter directives, and licence headers survive. Autocorrects. |
+| `Kata/IoDiscipline` | off | No bare `puts`/`warn`/`pp`/`p`; write through an injected `@io`. Enable with an `Include` on your output layer. |
+| `Kata/ProsePlacement` | off | Sentence-length strings belong in the presentation layer. Enable with an `Include`/`Exclude` matching your layering. |
+
+## The defaults
+
+Double-quoted strings, `Metrics/MethodLength: 5`, `Metrics/ClassLength: 100`,
+`Metrics/ParameterLists: 4`, 120-column lines, endless methods on one line,
+`rescue => error`, `NewCops: enable`, and heredocs counted as one line in
+spec examples. See
+[config/default.yml](config/default.yml).
+
+## License
+
+MIT.

data/config/default.yml

@@ -0,0 +1,106 @@
+plugins:
+  - rubocop-elegant
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-packaging
+  - rubocop-thread_safety
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "vendor/**/*"
+
+Kata/AgentNoun:
+  Description: "Name classes for the thing they are, not the work they do."
+  Enabled: true
+  VersionAdded: "0.1"
+  Include:
+    - "lib/**/*"
+  AllowedNames:
+    - Error
+
+Kata/NoComments:
+  Description: "Say it in the code; keep only comments the machine or the law reads."
+  Enabled: true
+  VersionAdded: "0.1"
+  Include:
+    - "lib/**/*"
+
+Kata/IoDiscipline:
+  Description: "Write through an injected io, not bare puts/warn/pp/p."
+  Enabled: false
+  VersionAdded: "0.1"
+
+Kata/ProsePlacement:
+  Description: "Keep sentence-length strings in the presentation layer."
+  Enabled: false
+  VersionAdded: "0.1"
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/ItBlockParameter:
+  EnforcedStyle: only_numbered_parameters
+
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/EndlessMethod:
+  EnforcedStyle: allow_single_line
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
+Layout/LineLength:
+  Max: 120
+
+Layout/LineEndStringConcatenationIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Metrics/ClassLength:
+  Max: 100
+
+Metrics/ModuleLength:
+  Max: 100
+  Exclude:
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Max: 5
+  Exclude:
+    - "spec/**/*"
+
+Metrics/ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+  Exclude:
+    - "spec/**/*"
+
+RSpec/ExampleLength:
+  CountAsOne:
+    - heredoc
+
+RSpec/VerifiedDoubles:
+  Enabled: true
+
+Elegant/NoEmptyLinesInBlocks:
+  Exclude:
+    - "spec/**/*"
+
+Elegant/NoComments:
+  Enabled: false
+
+ThreadSafety/DirChdir:
+  Exclude:
+    - "spec/**/*"

data/lib/rubocop/cop/kata/agent_noun.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class RuboCop::Cop::Kata::AgentNoun < RuboCop::Cop::Base
+  MSG = "`%s` names a doer; name the class for the thing it is, not the work it does."
+
+  SUFFIX = /(?:er|or)\z/
+
+  def on_class(node) = check(node)
+
+  def on_module(node) = check(node)
+
+  private
+
+  def check(node)
+    name = node.identifier.short_name.to_s
+    return unless SUFFIX.match?(name)
+    return if allowed?(name)
+    add_offense(node.identifier, message: format(MSG, name))
+  end
+
+  def allowed?(name) = Array(cop_config["AllowedNames"]).map(&:to_s).include?(name)
+end

data/lib/rubocop/cop/kata/io_discipline.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class RuboCop::Cop::Kata::IoDiscipline < RuboCop::Cop::Base
+  MSG = "Write through the injected `@io`, not bare `%s`."
+
+  RESTRICT_ON_SEND = %i[puts warn pp p].freeze
+
+  def_node_matcher :bare_output?, "(send nil? ${:puts :warn :pp :p} ...)"
+
+  def on_send(node)
+    bare_output?(node) do |method|
+      add_offense(node, message: format(MSG, method))
+    end
+  end
+end

data/lib/rubocop/cop/kata/no_comments.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class RuboCop::Cop::Kata::NoComments < RuboCop::Cop::Base
+  extend RuboCop::Cop::AutoCorrector
+
+  MSG = "Say it in the code: rename it, extract it, or name the constant."
+
+  MAGIC = /\A#\s*(frozen_string_literal|encoding|coding|warn_indent|shareable_constant_value):/
+  DIRECTIVE = /\A#\s*(rubocop|simplecov|rbs|steep|sorbet|typed|:nocov:)/
+  NOTICE = /^#\s*(copyright\b|\(c\)\s*\d|spdx-|licen[sc]ed under\b|licen[sc]e:|all rights reserved)/i
+  SHEBANG = /\A#!/
+
+  def on_new_investigation
+    header = notice
+    processed_source.comments.each { register(it) unless exempt?(it) || header.include?(it) }
+  end
+
+  private
+
+  def exempt?(comment)
+    text = comment.text
+    MAGIC.match?(text) || DIRECTIVE.match?(text) || NOTICE.match?(text) || SHEBANG.match?(text)
+  end
+
+  def notice
+    header = preamble
+    NOTICE.match?(header.map(&:text).join("\n")) ? header : []
+  end
+
+  def preamble
+    processed_source.comments.take_while { it.source_range.line < (processed_source.ast&.first_line || Float::INFINITY) }
+  end
+
+  def register(comment)
+    add_offense(comment) { |corrector| corrector.remove(removal(comment)) }
+  end
+
+  def removal(comment)
+    range = comment.source_range
+    alone?(range) ? line(range) : trailing(range)
+  end
+
+  def alone?(range) = range.source_line[0, range.column].strip.empty?
+
+  def line(range)
+    finish = range.end_pos
+    finish += 1 if processed_source.buffer.source[finish] == "\n"
+    range.with(begin_pos: range.begin_pos - range.column, end_pos: finish)
+  end
+
+  def trailing(range)
+    range.with(begin_pos: range.begin_pos - range.source_line[0, range.column][/\s*\z/].length)
+  end
+end

data/lib/rubocop/cop/kata/prose_placement.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class RuboCop::Cop::Kata::ProsePlacement < RuboCop::Cop::Base
+  MSG = "Prose belongs to the presentation layer — pass data and phrase it there."
+
+  WORDS = 5
+
+  def on_str(node)
+    add_offense(node) if prose?(node.value) && !exempt?(node)
+  end
+
+  def on_dstr(node)
+    add_offense(node) if prose?(node.each_child_node(:str).map(&:value).join(" ")) && !exempt?(node)
+  end
+
+  private
+
+  def prose?(text) = text.split(/\s+/).count { it.match?(/\A[A-Za-z][a-z]*[,.:;]?\z/) } >= WORDS
+
+  def exempt?(node)
+    node.each_ancestor(:send).any? { it.method?(:raise) } || node.each_ancestor(:dstr).any?
+  end
+end

data/lib/rubocop/kata/plugin.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+class RuboCop::Kata::Plugin < LintRoller::Plugin
+  def about
+    LintRoller::About.new(
+      name: "rubocop-kata", version: RuboCop::Kata::VERSION, homepage: "https://github.com/giacope/rubocop-kata",
+      description: "Practiced forms for Ruby: opinionated defaults and four house cops."
+    )
+  end
+
+  def supported?(context) = context.engine == :rubocop
+
+  def rules(_context)
+    LintRoller::Rules.new(
+      type: :path,
+      config_format: :rubocop,
+      value: Pathname.new(__dir__).join("../../../config/default.yml")
+    )
+  end
+end

data/lib/rubocop/kata/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Kata
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop-kata.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Kata
+  end
+
+  module Cop
+    module Kata
+    end
+  end
+end
+
+require_relative "rubocop/cop/kata/agent_noun"
+require_relative "rubocop/cop/kata/io_discipline"
+require_relative "rubocop/cop/kata/no_comments"
+require_relative "rubocop/cop/kata/prose_placement"
+require_relative "rubocop/kata/plugin"
+require_relative "rubocop/kata/version"

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-kata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giacomo GK
+bindir: bin
+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.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: '1.75'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+- !ruby/object:Gem::Dependency
+  name: rubocop-elegant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 'Bundles a curated RuboCop stack (rspec, performance, elegant, packaging,
+  thread_safety) behind one dependency, layers opinionated style defaults on top,
+  and adds four cops of its own: AgentNoun, NoComments, IoDiscipline, and ProsePlacement.'
+email:
+- giaco@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-kata.rb
+- lib/rubocop/cop/kata/agent_noun.rb
+- lib/rubocop/cop/kata/io_discipline.rb
+- lib/rubocop/cop/kata/no_comments.rb
+- lib/rubocop/cop/kata/prose_placement.rb
+- lib/rubocop/kata/plugin.rb
+- lib/rubocop/kata/version.rb
+homepage: https://github.com/giacope/rubocop-kata
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/giacope/rubocop-kata
+  changelog_uri: https://github.com/giacope/rubocop-kata/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/giacope/rubocop-kata/issues
+  default_lint_roller_plugin: RuboCop::Kata::Plugin
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.17
+specification_version: 4
+summary: 'Practiced forms for Ruby: a RuboCop plugin with opinionated defaults and
+  four house cops'
+test_files: []