kaizo 0.7.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a167afcda94e477c2fd351f0f88c4c4f69b4adb987e0e74a59f50c516aa6080
-  data.tar.gz: f002c0b1464262edc8eb988f046b935fb9347d2258585c143acc6dd46911f86b
+  metadata.gz: cad3868f708e0f017a8591fbc77881d53054d4fcc672c9a6adbfdb2ff7928834
+  data.tar.gz: 37b9f18bfd87518a2027ac6786352600d1c3d1f68153eeadbab8d964c835a90d
 SHA512:
-  metadata.gz: 41ec7ca0e3f99dc13c761540b9ac7c06bd66f1cbcdecf776db8f1dd4dcd0c412008ae70f6ac73e6d9295662a27d70b3c2b2973930674ea7229fc1d173b4bb33e
-  data.tar.gz: f3ea240a663c70959adf03f95c5b49452ae3ae71a93818b8dcdedcf8bf1b72f10acd9d1db95494e12f7ee592a3162b8590a5d99603caca710126c810147bdaca
+  metadata.gz: 74e87adf1362de156eac0285be0c51b89eec0b2209bf9371a3bf3ac52c41404b49c3f694bfebfea9ec9d3bf32ab572816e580575a39af5a568fc74bd844c91c5
+  data.tar.gz: 6789d9a9dabe6bcc17fb2d90702478d42d3593aed4e934743ed1f6c05946bfc1294d0a229173f1e345a1efc2f897a0f436630597ce33fac79e69430d50bc5cd6

data/CHANGELOG.md

@@ -1,5 +1,124 @@
 # Changelog
 
+## 0.9.1
+
+- `Kaizo/KeywordArguments` and `Kaizo/TotalArguments` no longer run on `spec/`
+  and `test/` trees: wide keyword interfaces are the testing idiom there
+  (FactoryBot-style `create`/`build` helpers), and a total bound would
+  re-police the keywords the exemption frees. Override with `Exclude: []` to
+  police tests too. `Kaizo/PositionalArguments` still runs everywhere --
+  positional arguments communicate nothing unless they are solo.
+- Rewrite the README example-first: every cop section leads with its bad/good
+  example, a fourteen-cop table replaces the catalog paragraph, a real
+  `rubocop --only Kaizo` transcript opens the document, and the enablement
+  policy is stated plainly (every cop ships enabled; the plugin's
+  out-of-department changes are disabling `Style/RedundantBegin` and the
+  `Style/HashSyntax` shorthand enforcement shipped since 0.8.0).
+- Verify the README in CI: `spec/readme_examples_spec.rb` executes every
+  example against the shipped config — bad code must be flagged by the cop
+  its marker names, good code must pass the whole department, YAML fences
+  must parse into real cops with shipped option keys, suffix claims run with
+  the documented merge applied, the console transcript is re-derived from the
+  cops, and every cop must have both a bad and a good example.
+- Fix two rdoc errors found in review: `Kaizo/AgentNounClassName`'s
+  `inherit_mode` example was a no-op (`Ledger` is already a default), and
+  `Kaizo/ExplicitBegin`'s docs called re-enabling `Style/RedundantBegin` an
+  opt-out when it leaves both cops fighting; the opt-out is disabling
+  `Kaizo/ExplicitBegin`.
+- Fix a README error found in review: the enablement policy named
+  `Style/RedundantBegin` as the only out-of-department change, omitting the
+  `Style/HashSyntax` shorthand enforcement the Public Config has shipped
+  since 0.8.0. The policy now names both, and a guard spec pins the Public
+  Config's foreign-cop list to exactly the two the README names.
+
+## 0.9.0
+
+- Add `Kaizo/TempfileCreate` cop: requires temporary files to be created with
+  block-form `Tempfile.create`, the only temp-file API whose cleanup is
+  deterministic (the block closes and removes the file when it returns).
+  `Tempfile.new` and `Tempfile.open` are flagged — their cleanup rides on a GC
+  finalizer that may run late or never — as is blockless `Tempfile.create`,
+  which returns a plain `File` that is never removed automatically. A
+  block-pass argument (`Tempfile.create("x", &writer)`) counts as a block. No
+  autocorrection. Enabled by default.
+- Add `Kaizo/SpecSubject` cop: requires the unit under test to be declared with
+  `subject`, not `let`. A `let`/`let!` is flagged when its block confidently
+  builds the class under test — a `.new` on `described_class`, on the constant
+  an enclosing `describe`/`context` names (full or short name), or on a
+  constant matching the spec's file name (`pool_spec.rb` names `Pool`,
+  `api_client_spec.rb` names `APIClient`). Deliberate second instances (an
+  `other` in an equality spec) are exempted with `AllowedMethods` /
+  `AllowedPatterns`, matched against the `let` name. Runs on `**/*_spec.rb`.
+  No autocorrection. Enabled by default.
+- `Kaizo/SpecComment` no longer inspects `spec/helpers` or `spec/support` by
+  default: those directories hold infrastructure, not specs, and prose there is
+  legitimate. The exclusion is plain per-cop `Exclude` configuration, so
+  override it (`Exclude: []`) to police them again, or broaden/narrow the scope
+  with the standard `Include`/`Exclude` as before.
+- `Kaizo/SpecDescriptionProse` no longer flags error class names in
+  descriptions: `it "raises Foo::Error"` passes, because the error is part of
+  the specified behavior — it is what the user ultimately sees raised. Any
+  constant path whose final segment ends in `Error` or `Exception` reads as
+  prose; the rest of the description is still checked.
+- `Kaizo/SpecDescriptionProse` gains `AllowedPatterns`: regexps matched against
+  the whole description that exempt it from every rule — the ad-hoc escape
+  hatch for a description that must quote something code-shaped.
+- **Renamed** `Kaizo/SpecDescriptionProse`'s options: `Conjunctions` is now
+  `ForbiddenWords` and `ContextPrefixes` is now `RequiredContextPrefixes`. The
+  old names said nothing about whether the lists include or exclude, or how
+  the filter works; the new ones do. This is a clean break: the old keys are
+  no longer read — RuboCop warns that the parameter is unsupported and the
+  shipped defaults apply — so rename them when upgrading.
+- The argument-counting cops (`Kaizo/PositionalArguments`,
+  `Kaizo/KeywordArguments`, `Kaizo/TotalArguments`) gain `AllowedMethods` and
+  `AllowedPatterns`: exempt individual methods by name or regexp — e.g. allow
+  `#initialize` to gather collaborators while everything else stays under a
+  strict `Max`. Covers `def`, `def self.`, and the symbol/string
+  `define_method` forms.
+- `Kaizo/PluralCollectionName`'s `ArrayMethods` list is now genuinely
+  configurable (the README already described it as such); the default list is
+  spelled out in the shipped config so `inherit_mode: merge` can extend it.
+- Every cop's rdoc header now carries a `== Configuration` section documenting
+  each option, its semantics, and its default, with a ready-to-paste
+  `.rubocop.yml` snippet — the config plane was previously undocumented at the
+  class level.
+
+## 0.8.0
+
+- Add `Kaizo/PluralCollectionName` cop: flags a method that returns an array
+  under a singular name (`def user` handing back `[first, second]`), since a
+  plural name documents what the caller gets. Ruby has no return types, so the
+  detection is a heuristic and errs toward silence — a method is flagged only
+  when every value it can return is unambiguously an array, so one branch
+  returning `nil` keeps it quiet. `ArrayMethods` covers calls whose result is an
+  `Array` whatever the receiver; `select` and `reject` are excluded on purpose,
+  since on a `Hash` they return a `Hash`. Predicate, writer, and operator
+  methods are exempt, as is `initialize`. `IrregularPlurals` handles plurals
+  without a trailing `s`. No autocorrection. Enabled by default.
+- The argument-counting cops (`Kaizo/PositionalArguments`, `Kaizo/TotalArguments`,
+  `Kaizo/KeywordArguments`) no longer flag **operator methods**. The arity of `[]=`
+  is fixed by Ruby's syntax — an index (or indices) plus the assigned value — so it
+  cannot be modeled away; the same holds for `[]`, `<=>`, `+`, `<<`, `==`, and the
+  rest of the operator family. Covers `def`, `def self.`, and the
+  `define_method(:[]=)` form; a `define_method` whose name is computed at runtime is
+  still checked, since the name cannot be known statically. This joins the existing
+  `Struct.new`/`Data.define` `initialize` exemption. Ordinary writers
+  (`def name=(value)`) are unaffected.
+- The Public Config now ships `Style/HashSyntax` with
+  `EnforcedShorthandSyntax: always`, preferring Ruby 3.1's hash-value shorthand
+  (`Session.new(table:)` over `Session.new(table: table)`). Override it in your own
+  config if you want the explicit form. *(Landed on `master` after 0.7.0 was
+  published, so it has not reached gem users yet and was never recorded here.)*
+- Expanded the `Kaizo/NestedMethodCalls` README guidance to spell out that the
+  *name* is the point, not the assignment — extracting to a local called `result`
+  or `tmp` satisfies the rule while missing what it asks for. The offense message
+  itself is unchanged.
+
+## 0.7.0
+
+- No user-facing changes. Internal tooling and gem metadata only — nothing in
+  the shipped cops or their configuration differed from 0.6.0.
+
 ## 0.6.0
 
 - **Renamed the gem from `rubocop-design` to `kaizo`**, and moved every cop from