rubocop-kata 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da7876f7f43029f7dfb90b0fb9527987fe9c50ee40336d0ba4fffdcc2cbad83f
-  data.tar.gz: 902e0c01d3cc5e71553d3c90c68a707b7f3a554cc3e6ec1228f0640ae8772d6a
+  metadata.gz: 0d5931b8e8bdf39595150f5f4c4785fd1e7c267c4abfda47d02999913aa4bdd2
+  data.tar.gz: 56fdf88f035c7833469f0a290351696b2a1197f1f5cee2282ad60928201b3323
 SHA512:
-  metadata.gz: 99fdeb3a9f112fbc7232f59da504bde048071f20d50e55ef367e5516119a307a68a4f071a371cdbbe7810248268ef526f5bbdec08c5e9068e14d17cee03661ca
-  data.tar.gz: 9603d8560c96c877a5cb8f614bf10cab2aabf63aa5aace3209cc0596b06dab7a0edd4372919068a5c345b48cff076c1964b453ba38caa1dd3d026a96ad6c8371
+  metadata.gz: 122b3da618e42d4137b1c4986bd21ba63374e275168d84181afa87cfae319465fe07270d12d54c3cece22ac6b73585a137d7ac5780f22f5a9c4fb0f667a40a07
+  data.tar.gz: b9bfb1dc0d5be32ea85898cfae3fbe3ce3338578f2e57b1e7b9effd2e00b2847c50bedcb5f9d259292de8141fe3579e11b0bb925a9840534047f26577f5dff26

data/CHANGELOG.md

@@ -1,5 +1,75 @@
 # Changelog
 
+## [0.10.0] - 2026-08-30
+
+- `Elegant/NoRedundantVariable`, `Elegant/PairedBrackets`, and
+  `Elegant/ClassInModule` now ship here, fixed, as `Kata/*` cops derived from
+  rubocop-elegant under MIT (`LICENSE.txt`); the originals are
+  off. The git-source Gemfile line is no longer needed: the correctors run
+  out of the box, and `ClassInModule` clears.
+
+## [0.9.0] - 2026-08-27
+
+- The shared rule behind the naming cops is now explicit: compound syntax is
+  not the smell — multiple semantic concepts are. A name should name one thing,
+  not describe where it came from, what it manipulates, or which layer it
+  lives in.
+- New `Kata/GoodClassName` replaces `Kata/AgentNoun` and the class half of
+  `Kata/NoUtilName`: a class names one object that exists in the model. It
+  keeps the doer check and its derived suggestions, adds junk-drawer names
+  matched whole or as a trailing segment (`Service` catches `InvoiceService`),
+  and flags names packing more than `MaxWords` concepts
+  (`CustomerOrderPayment`) unless `Terms` blesses them as one concept
+  (`CreditCard`). The default `Terms` ships the established technical
+  compounds: `AbstractSyntaxTree`, `RedBlackTree`, `UnitOfWork`,
+  `TimeWithZone`, `HashWithIndifferentAccess` and kin.
+- New `Kata/GoodModuleName` replaces the module half of `Kata/NoUtilName`: a
+  module names a domain vocabulary, not an implementation category. Layer
+  buckets (`Services`, `Helpers`, `Logic` — so `BusinessLogic` too), vague
+  shared namespaces (`Common`, `Shared`, `Core`), doer modules, and crowded
+  names are flagged; `AccessControl` and `Billing` pass.
+- `Kata/GoodMethodName` flags names chaining actions with a conjunction
+  (`validate_and_save`, `find_or_create`): each action wants its own method.
+  Traversal names (`customer_address`) were already priced by the word rule;
+  the message stays advisory — the cop cannot know your object model.
+- `Kata/GoodMethodName` and `Kata/GoodVariableName` bless grammatical
+  suffixes `id` and `ms` (`user_id`, `timeout_ms`) alongside `at`, the role
+  prefixes `max`/`min`/`start`/`end` (`max_retries`, `start_time`), and ship
+  established lexical compounds and protocol vocabulary as default `Terms`:
+  `first_name`, `postal_code`, `time_zone`, `ip_address`, `user_agent`,
+  `mime_type`, `status_code`, `access_token` and kin — names that read as one
+  concept. Where names must mirror an external schema, `Exclude` the file:
+  the file is the boundary.
+- The defaults were then pressure-tested against corpora of real stdlib, gem,
+  Rails, and business-domain names, and grew to absorb what any codebase hits:
+  role suffixes (`number`, `code`, `price`, `rate`, `date`, `path`, `url`,
+  `count`, `size`, `key`, `token`, `params`, `secret`, `level`, `file`, `dir`,
+  `period`, `seconds`, `cents`), role prefixes (`current`, `default`, `total`,
+  `new`, `other`, `raw`, `set`, `sort`, `expected`, `actual`, `assert`),
+  domain terms (`line_item`, `credit_card`, `payment_method`,
+  `billing_address`, `date_of_birth`, `dry_run`, `stack_trace` and kin), and
+  the contract names of Ruby, Rails, Sidekiq, Devise, Pundit and RSpec
+  (`perform_async`, `deconstruct_keys`, `authenticate_user!`, `policy_scope`,
+  `failure_message` and kin). Name suffixes that would bless owner+property
+  (`name`, `message`, `amount`) stayed out on purpose: `user_name` and
+  `error_message` are still priced.
+- `Kata/GoodClassName` `AllowedNames` also covers the class families a
+  framework resolves or subclasses by name (`Validator`, `Decorator`,
+  `Presenter`, `Helper`, `Job`, `Logger`, `Delegator`, `Enumerator`,
+  `Driver`) and more thing-words (`Center`, `Transfer`);
+  `Kata/GoodModuleName` mirrors the class cop's allowed list, and its
+  `BannedNames` grows the layer plurals (`Jobs`, `Workers`, `Queries`,
+  `Policies`, `Forms`, `Decorators`, `Presenters`, `Serializers`,
+  `Validators`, `Mixins`, `Extensions`).
+- The doer check no longer flags thing-words that merely end in `-er`/`-or`:
+  `User`, `Order`, `Customer`, `Monitor`, `Buffer` and kin ship in
+  `Kata/GoodClassName` `AllowedNames`. `Kata/GoodModuleName` ships the
+  framework suffixes (`Controller`, `Mailer`, `Serializer`) so reopening
+  `ActionController` is not an offense. `Kata/GoodMethodName` exempts the
+  names Ruby and Rails resolve by contract: `method_missing`,
+  `respond_to_missing?`, `marshal_dump`, `deep_dup`, `table_name`,
+  `primary_key` and kin.
+
 ## [0.8.0] - 2026-08-20
 
 - New `rubocop-kata plan` command: buckets the backlog into `structure`,

data/LICENSE.txt

@@ -19,3 +19,29 @@ 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.
+
+---
+
+Portions of this software are derived from rubocop-elegant
+(https://github.com/yegor256/rubocop-elegant), used under the same MIT
+License, whose notice is reproduced here as it requires:
+
+Copyright (c) 2019-2026 Yegor Bugayenko
+
+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

@@ -1,6 +1,6 @@
 # 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 fifteen house cops.
+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 eighteen house cops.
 
 `Kata/GoodMethodName` asks for one word per method name. A second word is
 allowed only when it is not hiding a missing object: a role prefix
@@ -14,10 +14,10 @@ that dodge with a shipped dictionary instead of a word list you maintain:
 
 - **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).
-- **Fifteen house cops.** Naming, dependency discipline, and data honesty in the Elegant Objects spirit — from `Kata/AgentNoun` to `Kata/ClockDiscipline`.
+- **Eighteen house cops.** Naming, dependency discipline, and data honesty in the Elegant Objects spirit — from `Kata/GoodClassName` to `Kata/ClockDiscipline`.
 
 ```ruby
-class PaymentProcessor  # Kata/AgentNoun: `PaymentProcessor` names a doer; name the class
+class PaymentProcessor  # Kata/GoodClassName: `PaymentProcessor` names a doer; name the class
 end                     #   for the thing it is, not the work it does. Try `Payment`.
 
 class Payment           # OK
@@ -65,50 +65,31 @@ reports a class nested in a class as global
 test-file exclusions never match a Rails or RSpec suite
 ([#77](https://github.com/yegor256/rubocop-elegant/issues/77)).
 
-The defaults here neutralise all four. `Elegant/ClassInModule` is off, because
-its offences cannot be cleared: the cop it ships beside forbids the module it
-asks for. The two broken correctors are set to report only, because their
-offences can be cleared, by hand. The exclusions are widened. Nothing corrupts
-your code out of the box, and nothing reports a defect you cannot fix.
+Until upstream releases the fixes, the three cops ship here, fixed, as
+`Kata/NoRedundantVariable`, `Kata/PairedBrackets`, and `Kata/ClassInModule`;
+the `Elegant/*` originals are off so each offence is reported once. They are
+derived from rubocop-elegant under its MIT licence, and the notice travels
+with the gem as `LICENSE.txt`. The exclusions are widened.
+Once upstream ships, the copies go and the originals come back on.
 
-A gemspec cannot name a git source, so to take the fixes themselves rather than
-the workarounds, add this to your own `Gemfile`:
-
-```ruby
-gem "rubocop-elegant", github: "giacope/rubocop-elegant", branch: "fixes"
-```
-
-That branch is the released gem plus the five pull requests, with the version
-pinned so Bundler resolves it. With it in place you can turn the two correctors
-back on:
-
-```yaml
-Elegant/NoRedundantVariable:
-  AutoCorrect: true
-
-Elegant/PairedBrackets:
-  AutoCorrect: true
-
-Elegant/ClassInModule:
-  Enabled: true
-```
-
-Drop all three once upstream releases the fixes. On a Rails codebase, consider
-leaving `Elegant/ClassInModule` off for good: it wants every class inside a
-module, and Zeitwerk resolves `class Account` from `app/models/account.rb` as a
-top-level constant by design.
+On a Rails codebase, consider turning `Kata/ClassInModule` off: it wants
+every class inside a module, and Zeitwerk resolves `class Account` from
+`app/models/account.rb` as a top-level constant by design.
 
 ## The cops
 
 | Cop | Default | What it enforces |
 | --- | --- | --- |
-| `Kata/AgentNoun` | on | Classes named for what they are, not `-er`/`-or` doers. Suggests the better name when it can derive one. `AllowedNames` matches a whole name or a trailing segment, so `Error` covers `UsageError`. |
+| `Kata/GoodClassName` | on | A class names one object that exists in the model: no `-er`/`-or` doers (suggests the better name when it can derive one), no junk drawers (`Service`, `Util`, `Data`), no packing several concepts into one name (`CustomerOrderPayment`). Compound syntax is not the smell — `CreditCard` is one concept, and `Terms` holds those. `AllowedNames` and `BannedNames` match a whole name or a trailing segment, so `Error` covers `UsageError` and `Service` catches `InvoiceService`. |
+| `Kata/GoodModuleName` | on | A module names a domain vocabulary (`Billing`, `AccessControl`), not an implementation category: no layer buckets (`Services`, `Helpers`, `Logic`), no vague shared namespaces (`Common`, `Shared`, `Core`), no doers. Tune via `BannedNames`/`Terms`/`AllowedNames`. |
+| `Kata/NoRedundantVariable` | on | A local assigned once and read once is inlined at its read, unless the move would cross a loop, a branch, or a side effect. Autocorrects, and keeps Ruby 3.1 shorthand intact. Fixed copy of `Elegant/NoRedundantVariable`. |
+| `Kata/PairedBrackets` | on | Every bracket pairs on its line, or opens at line end and closes at line start. Autocorrects without drifting the indent. Fixed copy of `Elegant/PairedBrackets`. |
+| `Kata/ClassInModule` | on | A class lives in a module, a class, or a compact namespace, never at the top level. Fixed copy of `Elegant/ClassInModule`. |
 | `Kata/NoComments` | on | No prose comments; say it in the code. Magic comments, linter directives, and licence headers survive. Autocorrects. |
 | `Kata/IoDiscipline` | on | No bare `puts`/`warn`/`pp`/`p` outside the test suite and the boot layer; write through an injected `@io` or an explicit receiver. |
 | `Kata/ProsePlacement` | off | Sentence-length strings belong in the presentation layer. Enable with an `Include`/`Exclude` matching your layering. |
-| `Kata/NoUtilName` | on | No junk-drawer names (`Util`, `Helper`, `Manager`, `Service`, …). Tune via `BannedNames`. |
 | `Kata/RealWords` | on | Every name segment is a word the shipped dictionary knows — `errorcount` (smash) and `cfg` (abbreviation) both fail, with no word list to maintain. Tune via `Terms`/`BannedWords`/`AllowedNames`. |
-| `Kata/GoodMethodName` | on | One word per method name; a second word needs a role prefix (`after_fork`), a role suffix (`file_of`), or a reviewed `Terms` entry. Tune via `MaxWords`/`Prefixes`/`Suffixes`/`Terms`/`AllowedNames`. |
+| `Kata/GoodMethodName` | on | One word per method name; a second word needs a role prefix (`after_fork`), a role suffix (`file_of`), or a reviewed `Terms` entry. A name chaining actions (`validate_and_save`, `find_or_create`) is flagged as two methods in one. Tune via `MaxWords`/`Prefixes`/`Suffixes`/`Terms`/`AllowedNames`. |
 | `Kata/GoodVariableName` | on | The same rule for locals, parameters, ivars, class variables, and globals; `_name` and `@_name` stay exempt. |
 | `Kata/BuilderNoun` | on | Builders named for what they return: `total`, not `calculate_total`. Tune via `BannedPrefixes`/`AllowedNames`. |
 | `Kata/NoBooleanFlag` | on | No positional boolean arguments; split the method or use a keyword. |
@@ -150,7 +131,7 @@ bundle exec rubocop-kata plan            # or: plan path/to/project
 
 ```
 structure     184  Kata/ConstructorDiscipline 92, Kata/NoHashAsObject 48, Kata/EnvDiscipline 44
-naming        263  Kata/RealWords 141, Kata/GoodVariableName 88, Kata/AgentNoun 34
+naming        263  Kata/RealWords 141, Kata/GoodVariableName 88, Kata/GoodClassName 34
 prose          57  Kata/NoComments 57
 rest          412  Elegant/PairedBrackets 300, Layout/LineLength 112
 next: structure — 184 offenses in 61 files; these mint the names `naming` then prices, so take them first