rigortype 0.4.5 → 0.4.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (452) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/data/gem_overlay/activesupport/core_ext.rbs +16 -13
  4. data/data/vendored_gem_sigs/bundler/bundler.rbs +1 -1
  5. data/data/vendored_gem_sigs/rubygems/rubygems_extras.rbs +4 -3
  6. data/docs/handbook/01-getting-started.md +5 -2
  7. data/docs/handbook/11-sig-gen.md +61 -5
  8. data/docs/handbook/appendix-phpstan.md +4 -4
  9. data/docs/manual/02-cli-reference.md +192 -27
  10. data/docs/manual/03-configuration.md +38 -4
  11. data/docs/manual/04-diagnostics.md +1 -1
  12. data/docs/manual/06-baseline.md +6 -4
  13. data/docs/manual/09-editor-integration.md +13 -2
  14. data/docs/manual/10-mcp-server.md +47 -3
  15. data/docs/manual/12-caching.md +9 -1
  16. data/docs/manual/plugins/rigor-actionmailer.md +30 -0
  17. data/docs/manual/plugins/rigor-actionpack.md +49 -11
  18. data/docs/manual/plugins/rigor-activesupport-core-ext.md +20 -1
  19. data/docs/manual/plugins/rigor-devise.md +15 -0
  20. data/docs/manual/plugins/rigor-rspec.md +2 -1
  21. data/lib/rigor/analysis/baseline.rb +24 -27
  22. data/lib/rigor/analysis/buffer_binding.rb +14 -0
  23. data/lib/rigor/analysis/check_rules/always_truthy_condition_collector.rb +5 -6
  24. data/lib/rigor/analysis/check_rules/dead_assignment_collector.rb +2 -2
  25. data/lib/rigor/analysis/check_rules/declaration_sourced_guard.rb +4 -4
  26. data/lib/rigor/analysis/check_rules/duplicate_hash_key_collector.rb +2 -2
  27. data/lib/rigor/analysis/check_rules/inferred_param_guard.rb +105 -12
  28. data/lib/rigor/analysis/check_rules/ivar_write_collector.rb +143 -15
  29. data/lib/rigor/analysis/check_rules/lexical_method_sites.rb +4 -1
  30. data/lib/rigor/analysis/check_rules/main_pass_collector.rb +5 -8
  31. data/lib/rigor/analysis/check_rules/published_constant_guard.rb +1 -1
  32. data/lib/rigor/analysis/check_rules/rbs_receiver_surface.rb +66 -3
  33. data/lib/rigor/analysis/check_rules/rebinding_block_callees/dispatch.rb +112 -0
  34. data/lib/rigor/analysis/check_rules/rebinding_block_callees.rb +394 -0
  35. data/lib/rigor/analysis/check_rules/return_in_ensure_collector.rb +1 -2
  36. data/lib/rigor/analysis/check_rules/ruby_deprecations.rb +7 -0
  37. data/lib/rigor/analysis/check_rules/rule_ids.rb +1 -1
  38. data/lib/rigor/analysis/check_rules/rule_walk.rb +9 -7
  39. data/lib/rigor/analysis/check_rules/shadowed_rescue_collector.rb +3 -4
  40. data/lib/rigor/analysis/check_rules/special_global_setters.rb +3 -3
  41. data/lib/rigor/analysis/check_rules/unreachable_clause_collector.rb +53 -2
  42. data/lib/rigor/analysis/check_rules/void_value_use_collector.rb +1 -1
  43. data/lib/rigor/analysis/check_rules.rb +217 -52
  44. data/lib/rigor/analysis/crash_signature.rb +2 -2
  45. data/lib/rigor/analysis/dependency_recorder.rb +15 -4
  46. data/lib/rigor/analysis/dependency_source_inference/boundary_cross_reporter.rb +14 -3
  47. data/lib/rigor/analysis/dependency_source_inference/gem_resolver.rb +1 -1
  48. data/lib/rigor/analysis/dependency_source_inference/index.rb +6 -8
  49. data/lib/rigor/analysis/dependency_source_inference/walker.rb +4 -4
  50. data/lib/rigor/analysis/edit_replay.rb +154 -0
  51. data/lib/rigor/analysis/fact_store.rb +3 -3
  52. data/lib/rigor/analysis/incremental.rb +37 -0
  53. data/lib/rigor/analysis/incremental_run_slot/write_guard.rb +2 -2
  54. data/lib/rigor/analysis/incremental_run_slot.rb +2 -2
  55. data/lib/rigor/analysis/incremental_session.rb +202 -43
  56. data/lib/rigor/analysis/path_expansion.rb +41 -0
  57. data/lib/rigor/analysis/require_relative_closure.rb +100 -0
  58. data/lib/rigor/analysis/rule_catalog.rb +7 -3
  59. data/lib/rigor/analysis/run_disclosure_credit.rb +80 -0
  60. data/lib/rigor/analysis/run_disclosure_ledger.rb +155 -0
  61. data/lib/rigor/analysis/run_stats.rb +2 -2
  62. data/lib/rigor/analysis/runner/buffer_pool_dispatcher.rb +8 -4
  63. data/lib/rigor/analysis/runner/declaration_position.rb +1 -1
  64. data/lib/rigor/analysis/runner/diagnostic_aggregator.rb +204 -96
  65. data/lib/rigor/analysis/runner/effect_envelope_pass.rb +1 -1
  66. data/lib/rigor/analysis/runner/pool_coordinator.rb +157 -320
  67. data/lib/rigor/analysis/runner/project_pre_passes.rb +48 -6
  68. data/lib/rigor/analysis/runner/run_level_facts.rb +304 -0
  69. data/lib/rigor/analysis/runner/run_snapshots.rb +44 -54
  70. data/lib/rigor/analysis/runner/scan_environment.rb +51 -0
  71. data/lib/rigor/analysis/runner/worker_payload.rb +36 -0
  72. data/lib/rigor/analysis/runner.rb +233 -120
  73. data/lib/rigor/analysis/self_call_resolution_recorder.rb +1 -1
  74. data/lib/rigor/analysis/template_unit_positions.rb +2 -3
  75. data/lib/rigor/analysis/template_units.rb +9 -1
  76. data/lib/rigor/analysis/worker_session.rb +38 -33
  77. data/lib/rigor/bleeding_edge.rb +3 -6
  78. data/lib/rigor/builtins/imported_refinements.rb +6 -8
  79. data/lib/rigor/builtins/predefined_constant_refinements.rb +1 -1
  80. data/lib/rigor/builtins/regex_refinement.rb +4 -6
  81. data/lib/rigor/cache/descriptor.rb +6 -5
  82. data/lib/rigor/cache/incremental_snapshot.rb +60 -18
  83. data/lib/rigor/cache/rbs_cache_producer.rb +2 -2
  84. data/lib/rigor/cache/rbs_class_ancestor_table.rb +1 -1
  85. data/lib/rigor/cache/rbs_class_type_param_names.rb +2 -2
  86. data/lib/rigor/cache/rbs_constant_table.rb +1 -1
  87. data/lib/rigor/cache/rbs_descriptor.rb +54 -3
  88. data/lib/rigor/cache/rbs_environment.rb +4 -1
  89. data/lib/rigor/cache/rbs_environment_marshal_patch.rb +2 -2
  90. data/lib/rigor/cache/rbs_known_class_names.rb +1 -1
  91. data/lib/rigor/cache/store.rb +11 -10
  92. data/lib/rigor/ci_detector.rb +1 -1
  93. data/lib/rigor/cli/annotate_command.rb +24 -19
  94. data/lib/rigor/cli/baseline_command.rb +145 -55
  95. data/lib/rigor/cli/catalogue.rb +256 -0
  96. data/lib/rigor/cli/check_command.rb +188 -93
  97. data/lib/rigor/cli/check_runner_factory.rb +2 -2
  98. data/lib/rigor/cli/command.rb +15 -1
  99. data/lib/rigor/cli/coverage_command.rb +21 -8
  100. data/lib/rigor/cli/coverage_mutation.rb +5 -7
  101. data/lib/rigor/cli/coverage_renderer.rb +2 -1
  102. data/lib/rigor/cli/coverage_scan.rb +3 -5
  103. data/lib/rigor/cli/diff_command.rb +27 -21
  104. data/lib/rigor/cli/docs_command.rb +1 -2
  105. data/lib/rigor/cli/doctor_command.rb +12 -12
  106. data/lib/rigor/cli/effects_command.rb +50 -40
  107. data/lib/rigor/cli/effects_diff_renderer.rb +18 -17
  108. data/lib/rigor/cli/effects_explain_renderer.rb +13 -12
  109. data/lib/rigor/cli/effects_renderer.rb +2 -1
  110. data/lib/rigor/cli/effects_snapshot_command.rb +18 -17
  111. data/lib/rigor/cli/explain_command.rb +18 -8
  112. data/lib/rigor/cli/fused_protection_renderer.rb +2 -1
  113. data/lib/rigor/cli/json_document.rb +41 -0
  114. data/lib/rigor/cli/lens_command.rb +17 -13
  115. data/lib/rigor/cli/lsp_command.rb +250 -23
  116. data/lib/rigor/cli/mcp_command.rb +14 -8
  117. data/lib/rigor/cli/mutation_fork_scan.rb +1 -1
  118. data/lib/rigor/cli/mutation_protection_renderer.rb +3 -2
  119. data/lib/rigor/cli/options.rb +60 -4
  120. data/lib/rigor/cli/plugin_command.rb +93 -46
  121. data/lib/rigor/cli/plugins_command.rb +22 -18
  122. data/lib/rigor/cli/plugins_renderer.rb +34 -8
  123. data/lib/rigor/cli/protection_fork_scan.rb +2 -2
  124. data/lib/rigor/cli/protection_renderer.rb +2 -1
  125. data/lib/rigor/cli/show_bleedingedge_command.rb +23 -16
  126. data/lib/rigor/cli/sig_gen_command.rb +130 -34
  127. data/lib/rigor/cli/skill_command.rb +32 -3
  128. data/lib/rigor/cli/skill_deep_probe.rb +1 -1
  129. data/lib/rigor/cli/skill_describe.rb +1 -1
  130. data/lib/rigor/cli/trace_command.rb +14 -9
  131. data/lib/rigor/cli/triage_command.rb +10 -11
  132. data/lib/rigor/cli/triage_renderer.rb +2 -1
  133. data/lib/rigor/cli/type_of_command.rb +18 -12
  134. data/lib/rigor/cli/type_of_project_scope.rb +24 -0
  135. data/lib/rigor/cli/type_of_renderer.rb +4 -1
  136. data/lib/rigor/cli/type_scan_command.rb +14 -9
  137. data/lib/rigor/cli/type_scan_renderer.rb +2 -1
  138. data/lib/rigor/cli/unused_command.rb +27 -17
  139. data/lib/rigor/cli/upgrade_command.rb +5 -0
  140. data/lib/rigor/cli.rb +209 -54
  141. data/lib/rigor/config_audit.rb +17 -6
  142. data/lib/rigor/configuration/severity_profile.rb +5 -5
  143. data/lib/rigor/configuration.rb +86 -34
  144. data/lib/rigor/effects/definition_context.rb +0 -2
  145. data/lib/rigor/effects/envelope.rb +1 -1
  146. data/lib/rigor/effects/framework_units.rb +1 -1
  147. data/lib/rigor/effects/mutation_classifier.rb +4 -7
  148. data/lib/rigor/effects/propagator.rb +1 -1
  149. data/lib/rigor/effects/registry.rb +2 -2
  150. data/lib/rigor/effects/snapshot.rb +1 -1
  151. data/lib/rigor/effects/taint_cause.rb +0 -2
  152. data/lib/rigor/effects/unit_scan.rb +9 -13
  153. data/lib/rigor/environment/bundle_sig_discovery.rb +5 -9
  154. data/lib/rigor/environment/class_registry.rb +3 -3
  155. data/lib/rigor/environment/core_root.rb +77 -0
  156. data/lib/rigor/environment/default_libraries.rb +1 -1
  157. data/lib/rigor/environment/deferred_signature_plan.rb +283 -0
  158. data/lib/rigor/environment/gated_signature_guard.rb +1 -1
  159. data/lib/rigor/environment/gated_signature_plan.rb +5 -2
  160. data/lib/rigor/environment/lockfile_resolver.rb +28 -12
  161. data/lib/rigor/environment/member_consistency/comparator.rb +18 -1
  162. data/lib/rigor/environment/member_consistency.rb +56 -7
  163. data/lib/rigor/environment/missing_gem_constant_index.rb +3 -2
  164. data/lib/rigor/environment/project_path_gems.rb +124 -0
  165. data/lib/rigor/environment/rbs_hierarchy.rb +6 -15
  166. data/lib/rigor/environment/rbs_loader.rb +592 -70
  167. data/lib/rigor/environment/reflection.rb +7 -7
  168. data/lib/rigor/environment/required_features.rb +136 -32
  169. data/lib/rigor/environment/ruby_library_roots.rb +122 -0
  170. data/lib/rigor/environment/vendored_signature_plan.rb +153 -0
  171. data/lib/rigor/environment.rb +44 -11
  172. data/lib/rigor/flow_contribution/merger.rb +4 -4
  173. data/lib/rigor/inference/acceptance.rb +93 -32
  174. data/lib/rigor/inference/block_parameter_binder.rb +2 -3
  175. data/lib/rigor/inference/block_run_count.rb +178 -0
  176. data/lib/rigor/inference/budget_trace.rb +8 -2
  177. data/lib/rigor/inference/builtins/exception_catalog.rb +2 -2
  178. data/lib/rigor/inference/builtins/numeric_catalog.rb +2 -5
  179. data/lib/rigor/inference/builtins/random_catalog.rb +2 -2
  180. data/lib/rigor/inference/callee_mutation_chain.rb +126 -0
  181. data/lib/rigor/inference/callee_write_census.rb +815 -0
  182. data/lib/rigor/inference/construction_escape.rb +217 -0
  183. data/lib/rigor/inference/declaration_walk/traversal.rb +1 -1
  184. data/lib/rigor/inference/deep_erasure.rb +170 -0
  185. data/lib/rigor/inference/def_handle.rb +1 -1
  186. data/lib/rigor/inference/def_node_resolver.rb +1 -1
  187. data/lib/rigor/inference/def_return_typer.rb +204 -12
  188. data/lib/rigor/inference/definer_resolution.rb +21 -5
  189. data/lib/rigor/inference/definers_index.rb +106 -0
  190. data/lib/rigor/inference/direct_ivar_writes.rb +300 -0
  191. data/lib/rigor/inference/element_read_widening.rb +49 -3
  192. data/lib/rigor/inference/error_info.rb +17 -3
  193. data/lib/rigor/inference/expression_typer.rb +173 -57
  194. data/lib/rigor/inference/external_ancestor_resolution.rb +3 -4
  195. data/lib/rigor/inference/global_write_census.rb +110 -1
  196. data/lib/rigor/inference/global_writer_reach.rb +260 -0
  197. data/lib/rigor/inference/hkt_body.rb +1 -2
  198. data/lib/rigor/inference/hkt_body_parser.rb +3 -5
  199. data/lib/rigor/inference/hkt_reducer.rb +2 -2
  200. data/lib/rigor/inference/hkt_registry.rb +3 -5
  201. data/lib/rigor/inference/indexed_narrowing.rb +4 -7
  202. data/lib/rigor/inference/intervening_ivar_reset.rb +26 -4
  203. data/lib/rigor/inference/ivar_writer_census.rb +246 -0
  204. data/lib/rigor/inference/key_presence_guard.rb +2 -1
  205. data/lib/rigor/inference/loop_value_record.rb +57 -0
  206. data/lib/rigor/inference/match_rebinding/frame.rb +65 -0
  207. data/lib/rigor/inference/match_rebinding/yielding_match.rb +45 -0
  208. data/lib/rigor/inference/match_rebinding.rb +11 -1
  209. data/lib/rigor/inference/memo_audit.rb +55 -0
  210. data/lib/rigor/inference/method_dispatcher/alias_strict_nominals.rb +1 -1
  211. data/lib/rigor/inference/method_dispatcher/argument_distribution.rb +40 -0
  212. data/lib/rigor/inference/method_dispatcher/block_folding.rb +1 -1
  213. data/lib/rigor/inference/method_dispatcher/constant_folding.rb +113 -12
  214. data/lib/rigor/inference/method_dispatcher/contested_overloads.rb +89 -0
  215. data/lib/rigor/inference/method_dispatcher/iterator_dispatch.rb +1 -1
  216. data/lib/rigor/inference/method_dispatcher/kernel_dispatch.rb +7 -3
  217. data/lib/rigor/inference/method_dispatcher/no_match_fallback.rb +54 -0
  218. data/lib/rigor/inference/method_dispatcher/overload_selector.rb +39 -27
  219. data/lib/rigor/inference/method_dispatcher/random_folding.rb +1 -1
  220. data/lib/rigor/inference/method_dispatcher/rbs_dispatch.rb +203 -17
  221. data/lib/rigor/inference/method_dispatcher/reduce_folding.rb +1 -1
  222. data/lib/rigor/inference/method_dispatcher/regexp_folding.rb +2 -2
  223. data/lib/rigor/inference/method_dispatcher/self_substitute.rb +2 -2
  224. data/lib/rigor/inference/method_dispatcher/set_folding.rb +59 -24
  225. data/lib/rigor/inference/method_dispatcher/shape_dispatch.rb +83 -20
  226. data/lib/rigor/inference/method_dispatcher/singleton_folding.rb +0 -1
  227. data/lib/rigor/inference/method_dispatcher/singleton_mixin_dispatch.rb +50 -17
  228. data/lib/rigor/inference/method_dispatcher/struct_folding.rb +5 -5
  229. data/lib/rigor/inference/method_dispatcher/struct_materialization.rb +4 -6
  230. data/lib/rigor/inference/method_dispatcher/uri_folding.rb +1 -1
  231. data/lib/rigor/inference/method_dispatcher.rb +109 -29
  232. data/lib/rigor/inference/module_function_state/spellings.rb +64 -0
  233. data/lib/rigor/inference/module_function_state.rb +23 -1
  234. data/lib/rigor/inference/multi_target_binder.rb +1 -1
  235. data/lib/rigor/inference/mutation_rejoin.rb +240 -4
  236. data/lib/rigor/inference/mutation_widening.rb +162 -29
  237. data/lib/rigor/inference/narrowing.rb +113 -38
  238. data/lib/rigor/inference/object_mixins.rb +13 -1
  239. data/lib/rigor/inference/optimistic_origin.rb +1 -1
  240. data/lib/rigor/inference/out_buffer_mutation.rb +72 -0
  241. data/lib/rigor/inference/parameter_inference_collector.rb +5 -6
  242. data/lib/rigor/inference/pre_eval_constants.rb +1 -1
  243. data/lib/rigor/inference/project_method_ownership.rb +6 -3
  244. data/lib/rigor/inference/project_seed_tables.rb +2 -1
  245. data/lib/rigor/inference/project_yielder.rb +122 -0
  246. data/lib/rigor/inference/receiver_alias.rb +20 -0
  247. data/lib/rigor/inference/refined_dispatch/constructed_class.rb +3 -1
  248. data/lib/rigor/inference/refined_dispatch/own_method.rb +2 -1
  249. data/lib/rigor/inference/remover_holder_scan.rb +233 -0
  250. data/lib/rigor/inference/remover_narrowing.rb +224 -0
  251. data/lib/rigor/inference/rewrite_mutation.rb +53 -2
  252. data/lib/rigor/inference/scope_indexer/certainty.rb +9 -1
  253. data/lib/rigor/inference/scope_indexer/constant_ivar_value.rb +93 -0
  254. data/lib/rigor/inference/scope_indexer/declared_ivar_types.rb +64 -0
  255. data/lib/rigor/inference/scope_indexer/declared_param_writes.rb +205 -0
  256. data/lib/rigor/inference/scope_indexer/derived_param_value.rb +112 -0
  257. data/lib/rigor/inference/scope_indexer/empty_seed.rb +99 -0
  258. data/lib/rigor/inference/scope_indexer/ivar_contributions.rb +135 -0
  259. data/lib/rigor/inference/scope_indexer/unseen_ivar_writers.rb +133 -0
  260. data/lib/rigor/inference/scope_indexer.rb +614 -146
  261. data/lib/rigor/inference/self_call_ivar_writes.rb +101 -17
  262. data/lib/rigor/inference/set_mutation.rb +189 -0
  263. data/lib/rigor/inference/singleton_hook_decline.rb +1 -2
  264. data/lib/rigor/inference/statement_evaluator.rb +3036 -278
  265. data/lib/rigor/inference/struct_fold_safety.rb +4 -6
  266. data/lib/rigor/inference/synthetic_method_index.rb +23 -0
  267. data/lib/rigor/inference/synthetic_method_scanner/project_members.rb +130 -0
  268. data/lib/rigor/inference/synthetic_method_scanner.rb +73 -14
  269. data/lib/rigor/inference/toplevel_def_census.rb +59 -0
  270. data/lib/rigor/inference/unknown_store_widening.rb +103 -4
  271. data/lib/rigor/inference/unthreaded_rebinds.rb +2 -3
  272. data/lib/rigor/inference/void_tail_summary.rb +2 -1
  273. data/lib/rigor/language_server/buffer_table.rb +9 -3
  274. data/lib/rigor/language_server/completion_provider.rb +26 -20
  275. data/lib/rigor/language_server/config_warning_announcer.rb +28 -0
  276. data/lib/rigor/language_server/diagnostic_publisher.rb +28 -9
  277. data/lib/rigor/language_server/document_symbol_provider.rb +1 -1
  278. data/lib/rigor/language_server/folding_range_provider.rb +1 -2
  279. data/lib/rigor/language_server/hover_provider.rb +1 -7
  280. data/lib/rigor/language_server/hover_renderer.rb +6 -8
  281. data/lib/rigor/language_server/project_context.rb +98 -4
  282. data/lib/rigor/language_server/publish_batcher.rb +3 -4
  283. data/lib/rigor/language_server/selection_range_provider.rb +2 -4
  284. data/lib/rigor/language_server/server.rb +12 -6
  285. data/lib/rigor/language_server/signature_help_provider.rb +4 -4
  286. data/lib/rigor/lens/plugins.rb +1 -1
  287. data/lib/rigor/mcp/server.rb +82 -3
  288. data/lib/rigor/mcp.rb +1 -1
  289. data/lib/rigor/plugin/access_denied_error.rb +1 -2
  290. data/lib/rigor/plugin/base.rb +26 -11
  291. data/lib/rigor/plugin/bundled_catalog.rb +1 -12
  292. data/lib/rigor/plugin/io_boundary.rb +1 -1
  293. data/lib/rigor/plugin/loader.rb +25 -8
  294. data/lib/rigor/plugin/macro/heredoc_template.rb +7 -8
  295. data/lib/rigor/plugin/macro/trait_registry.rb +6 -9
  296. data/lib/rigor/plugin/manifest.rb +38 -16
  297. data/lib/rigor/plugin/registry.rb +41 -3
  298. data/lib/rigor/plugin/services.rb +2 -3
  299. data/lib/rigor/plugin/source_rbs_synthesis_reporter.rb +11 -0
  300. data/lib/rigor/plugin/trust_policy.rb +2 -2
  301. data/lib/rigor/plugin/type_node_resolver.rb +2 -4
  302. data/lib/rigor/plugin.rb +6 -8
  303. data/lib/rigor/plugin_gap_advisory.rb +5 -1
  304. data/lib/rigor/project_environment.rb +16 -2
  305. data/lib/rigor/protection/analysis_guard.rb +1 -1
  306. data/lib/rigor/protection/discovery_seed.rb +96 -2
  307. data/lib/rigor/protection/mutator.rb +1 -1
  308. data/lib/rigor/rbs_extended/envelope_scanner.rb +4 -6
  309. data/lib/rigor/rbs_extended/hkt_directives.rb +6 -10
  310. data/lib/rigor/rbs_extended/reporter.rb +27 -3
  311. data/lib/rigor/rbs_extended.rb +2 -3
  312. data/lib/rigor/reflection/constant_ancestors.rb +5 -3
  313. data/lib/rigor/rooted_glob.rb +25 -2
  314. data/lib/rigor/run_scoped_slots.rb +38 -0
  315. data/lib/rigor/runtime/jit.rb +1 -1
  316. data/lib/rigor/scope/discovery_index.rb +19 -6
  317. data/lib/rigor/scope/resolution_chain.rb +3 -1
  318. data/lib/rigor/scope.rb +379 -36
  319. data/lib/rigor/sig_gen/classification.rb +4 -0
  320. data/lib/rigor/sig_gen/effect_annotation.rb +3 -3
  321. data/lib/rigor/sig_gen/generator.rb +668 -84
  322. data/lib/rigor/sig_gen/generic_header_scan.rb +189 -0
  323. data/lib/rigor/sig_gen/inline_declarations.rb +2 -2
  324. data/lib/rigor/sig_gen/layout_index.rb +3 -3
  325. data/lib/rigor/sig_gen/method_candidate.rb +23 -4
  326. data/lib/rigor/sig_gen/observation_collector.rb +7 -6
  327. data/lib/rigor/sig_gen/observed_call.rb +1 -1
  328. data/lib/rigor/sig_gen/path_mapper.rb +6 -0
  329. data/lib/rigor/sig_gen/rbs_validity.rb +1 -1
  330. data/lib/rigor/sig_gen/renderer.rb +21 -12
  331. data/lib/rigor/sig_gen/skip_reason_catalog.rb +15 -2
  332. data/lib/rigor/sig_gen/type_elaborator.rb +21 -5
  333. data/lib/rigor/sig_gen/type_name_qualification.rb +69 -0
  334. data/lib/rigor/sig_gen/write_reporter.rb +63 -14
  335. data/lib/rigor/sig_gen/write_result.rb +23 -12
  336. data/lib/rigor/sig_gen/writer.rb +217 -37
  337. data/lib/rigor/type/acceptance_router.rb +2 -2
  338. data/lib/rigor/type/accepts_result.rb +1 -1
  339. data/lib/rigor/type/app.rb +4 -6
  340. data/lib/rigor/type/combinator.rb +13 -16
  341. data/lib/rigor/type/constant.rb +48 -7
  342. data/lib/rigor/type/hash_shape.rb +26 -40
  343. data/lib/rigor/type/struct_instance.rb +3 -2
  344. data/lib/rigor/type/union.rb +1 -1
  345. data/lib/rigor/type_node/identifier.rb +1 -2
  346. data/lib/rigor/type_node/resolver_chain.rb +1 -1
  347. data/lib/rigor/type_node/string_literal.rb +1 -2
  348. data/lib/rigor/type_node/symbol_literal.rb +1 -2
  349. data/lib/rigor/type_node/union.rb +3 -6
  350. data/lib/rigor/value_semantics.rb +1 -10
  351. data/lib/rigor/version.rb +1 -1
  352. data/plugins/rigor-actioncable/lib/rigor/plugin/actioncable/channel_discoverer.rb +2 -2
  353. data/plugins/rigor-actioncable/lib/rigor/plugin/actioncable/channel_index.rb +2 -3
  354. data/plugins/rigor-actioncable/lib/rigor/plugin/actioncable.rb +1 -1
  355. data/plugins/rigor-actionmailer/lib/rigor/plugin/actionmailer/mailer_discoverer.rb +89 -70
  356. data/plugins/rigor-actionmailer/lib/rigor/plugin/actionmailer/mailer_index.rb +4 -2
  357. data/plugins/rigor-actionmailer/lib/rigor/plugin/actionmailer.rb +25 -4
  358. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/analyzer.rb +1 -1
  359. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/controller_index.rb +1 -5
  360. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/controller_scan.rb +0 -1
  361. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/erb_compiler.rb +2 -1
  362. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/view_assigns.rb +1 -1
  363. data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack.rb +79 -19
  364. data/plugins/rigor-activejob/lib/rigor/plugin/activejob/effects.rb +1 -1
  365. data/plugins/rigor-activejob/lib/rigor/plugin/activejob.rb +6 -3
  366. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/association_roots.rb +3 -2
  367. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/effects.rb +2 -2
  368. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/model_discoverer.rb +21 -31
  369. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/model_index.rb +10 -16
  370. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/schema_parser.rb +2 -3
  371. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/schema_table.rb +0 -1
  372. data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord.rb +5 -4
  373. data/plugins/rigor-activestorage/lib/rigor/plugin/activestorage/attachment_discoverer.rb +3 -4
  374. data/plugins/rigor-activestorage/lib/rigor/plugin/activestorage/attachment_index.rb +1 -1
  375. data/plugins/rigor-activestorage/lib/rigor/plugin/activestorage.rb +7 -12
  376. data/plugins/rigor-activestorage/lib/rigor-activestorage.rb +1 -1
  377. data/plugins/rigor-activesupport-core-ext/lib/rigor/plugin/activesupport_core_ext/effects.rb +1 -1
  378. data/plugins/rigor-activesupport-core-ext/lib/rigor/plugin/activesupport_core_ext/symbolize_keys.rb +102 -0
  379. data/plugins/rigor-activesupport-core-ext/lib/rigor/plugin/activesupport_core_ext.rb +19 -6
  380. data/plugins/rigor-activesupport-core-ext/sig/active_support/core_ext.rbs +26 -13
  381. data/plugins/rigor-alba/lib/rigor/plugin/alba/resource_index.rb +3 -3
  382. data/plugins/rigor-devise/lib/rigor/plugin/devise.rb +5 -3
  383. data/plugins/rigor-dry-schema/lib/rigor/plugin/dry_schema/schema_scanner.rb +1 -3
  384. data/plugins/rigor-dry-struct/lib/rigor/plugin/dry_struct.rb +6 -6
  385. data/plugins/rigor-dry-types/lib/rigor/plugin/dry_types/alias_scanner.rb +5 -6
  386. data/plugins/rigor-dry-types/lib/rigor/plugin/dry_types.rb +7 -6
  387. data/plugins/rigor-dry-validation/lib/rigor/plugin/dry_validation/params_shape.rb +2 -3
  388. data/plugins/rigor-dry-validation/lib/rigor/plugin/dry_validation.rb +5 -8
  389. data/plugins/rigor-ethon/lib/rigor/plugin/ethon.rb +0 -1
  390. data/plugins/rigor-factorybot/lib/rigor/plugin/factorybot/factory_discoverer.rb +1 -1
  391. data/plugins/rigor-factorybot/lib/rigor/plugin/factorybot.rb +10 -18
  392. data/plugins/rigor-ffi/lib/rigor/plugin/ffi/analyzer.rb +0 -1
  393. data/plugins/rigor-ffi/lib/rigor/plugin/ffi/discoverer.rb +0 -2
  394. data/plugins/rigor-ffi/lib/rigor/plugin/ffi.rb +4 -5
  395. data/plugins/rigor-grape/lib/rigor/plugin/grape.rb +0 -2
  396. data/plugins/rigor-graphql/lib/rigor/plugin/graphql/type_scanner.rb +6 -7
  397. data/plugins/rigor-hanami/lib/rigor/plugin/hanami/action_checker.rb +2 -4
  398. data/plugins/rigor-hanami/lib/rigor/plugin/hanami.rb +2 -5
  399. data/plugins/rigor-mangrove/lib/rigor/plugin/mangrove.rb +2 -2
  400. data/plugins/rigor-minitest/lib/rigor/plugin/minitest/assertion_analyzer.rb +6 -6
  401. data/plugins/rigor-pundit/lib/rigor/plugin/pundit/policy_discoverer.rb +2 -1
  402. data/plugins/rigor-rails-i18n/lib/rigor/plugin/rails_i18n/analyzer.rb +3 -8
  403. data/plugins/rigor-rails-i18n/lib/rigor/plugin/rails_i18n/locale_index.rb +2 -3
  404. data/plugins/rigor-rails-i18n/lib/rigor/plugin/rails_i18n/locale_loader.rb +5 -8
  405. data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/analyzer.rb +1 -3
  406. data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/devise_routes.rb +2 -3
  407. data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/helper_discoverer.rb +1 -1
  408. data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/routes_parser.rb +4 -11
  409. data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes.rb +1 -1
  410. data/plugins/rigor-rbs-inline/lib/rigor/plugin/rbs_inline.rb +2 -1
  411. data/plugins/rigor-rspec/lib/rigor/plugin/rspec/matcher_analyzer.rb +102 -11
  412. data/plugins/rigor-rspec/lib/rigor/plugin/rspec.rb +2 -2
  413. data/plugins/rigor-rspec-rails/lib/rigor/plugin/rspec_rails.rb +3 -4
  414. data/plugins/rigor-shoulda-matchers/lib/rigor/plugin/shoulda_matchers/analyzer.rb +6 -8
  415. data/plugins/rigor-sidekiq/lib/rigor/plugin/sidekiq.rb +5 -2
  416. data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet/absurd_recognizer.rb +4 -5
  417. data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet/assertion_recognizer.rb +6 -7
  418. data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet/catalog.rb +1 -1
  419. data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet/sig_parser.rb +2 -2
  420. data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet.rb +17 -21
  421. data/plugins/rigor-statesman/lib/rigor/plugin/statesman.rb +2 -3
  422. data/plugins/rigor-typelizer/lib/rigor/plugin/typelizer/serializer_discoverer.rb +3 -2
  423. data/plugins/rigor-typelizer/lib/rigor/plugin/typelizer/serializer_index.rb +4 -4
  424. data/plugins/rigor-typelizer/lib/rigor/plugin/typelizer.rb +1 -1
  425. data/sig/rigor/analysis/baseline.rbs +0 -2
  426. data/sig/rigor/analysis/fact_store.rbs +1 -0
  427. data/sig/rigor/analysis/reachability/scan_cache.rbs +1 -1
  428. data/sig/rigor/cli/diff_command.rbs +1 -1
  429. data/sig/rigor/cli/explain_command.rbs +1 -1
  430. data/sig/rigor/effects/file_collection.rbs +5 -6
  431. data/sig/rigor/effects/registry.rbs +8 -6
  432. data/sig/rigor/effects/summary.rbs +6 -5
  433. data/sig/rigor/environment.rbs +5 -3
  434. data/sig/rigor/inference/optimistic_origin.rbs +11 -0
  435. data/sig/rigor/inference.rbs +10 -1
  436. data/sig/rigor/plugin/additional_initializer.rbs +0 -5
  437. data/sig/rigor/plugin/base.rbs +1 -0
  438. data/sig/rigor/plugin/effect_ancestry.rbs +6 -4
  439. data/sig/rigor/plugin/effect_attribution.rbs +25 -10
  440. data/sig/rigor/plugin/effect_edge.rbs +12 -5
  441. data/sig/rigor/plugin/effect_entry_points.rbs +8 -3
  442. data/sig/rigor/plugin/io_boundary.rbs +6 -5
  443. data/sig/rigor/plugin/manifest.rbs +16 -18
  444. data/sig/rigor/plugin/protocol_contract.rbs +6 -9
  445. data/sig/rigor/plugin/registry.rbs +1 -1
  446. data/sig/rigor/scope.rbs +51 -50
  447. data/sig/rigor/type.rbs +0 -6
  448. data/skills/rigor-plugin-author/SKILL.md +4 -4
  449. data/skills/rigor-plugin-author/references/02-walker-and-types.md +5 -5
  450. data/skills/rigor-plugin-review/SKILL.md +3 -3
  451. data/skills/rigor-project-init/references/03-baseline-and-bugs.md +12 -1
  452. metadata +55 -3
@@ -0,0 +1,256 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "optparse"
4
+
5
+ require_relative "options"
6
+ require_relative "../version"
7
+ require_relative "json_document"
8
+
9
+ module Rigor
10
+ class CLI
11
+ # The machine-readable description of the CLI surface (ADR-126 WD3): one entry per command, with the one-line
12
+ # summary, usage, subcommands, flags, accepted formats and the MCP tool that mirrors it.
13
+ #
14
+ # Nothing here is a second hand-written list of flags. The commands that parse with an `OptionParser` expose the
15
+ # parser they build (`#option_parser`, built without parsing anything) and the catalogue reads its switches; the
16
+ # commands that read `argv` by hand declare theirs in {DECLARED}. The only prose kept here is the one-line
17
+ # {SUMMARIES}, which `rigor help` prints, so the text help and `rigor help --format=json` cannot disagree about
18
+ # which commands exist. `spec/rigor/cli/catalogue_spec.rb` gates the names against `CLI::HANDLERS`.
19
+ module Catalogue
20
+ SCHEMA_VERSION = JsonDocument::SCHEMA_VERSION
21
+
22
+ # `help` and `version` are dispatched by `CLI#run` itself, outside `CLI::HANDLERS`.
23
+ BUILTINS = %w[help version].freeze
24
+
25
+ # The `rigor help` listing, in print order.
26
+ SUMMARIES = {
27
+ "check" => "Analyze Ruby source files",
28
+ "init" => "Create a starter .rigor.yml",
29
+ "annotate" => "Print FILE with each line's last-expression type",
30
+ "type-of" => "Print inferred types at FILE:LINE[:COL] positions",
31
+ "lens" => "Map a file's declarations with their types and provenance (experimental)",
32
+ "trace" => "Replay how the engine typed FILE as a terminal animation",
33
+ "type-scan" => "Report Scope#type_of coverage across PATHs",
34
+ "effects" => "Report each method's effect labels, and the committed effect snapshot " \
35
+ "(opt-in; effects update/check/diff/explain)",
36
+ "explain" => "Print the description of one or all CheckRules",
37
+ "diff" => "Compare current diagnostics to a saved `rigor check --format=json` result",
38
+ "baseline" => "Manage the baseline file (baseline generate/regenerate/dump/drift/prune)",
39
+ "sig-gen" => "Emit RBS skeletons inferred from .rb sources",
40
+ "lsp" => "Run the Rigor Language Server (LSP) over stdio",
41
+ "mcp" => "Run the Rigor MCP server over stdio",
42
+ "triage" => "Summarise diagnostics: distribution, hotspots, hints",
43
+ "coverage" => "Report type-precision coverage (precise vs Dynamic ratio)",
44
+ "unused" => "Report unreferenced classes, modules and constants as removal candidates",
45
+ "plugins" => "Report activation status of every configured plugin",
46
+ "plugin" => "Browse bundled plugin source as worked examples (plugin <name>, plugin --list)",
47
+ "playground" => "Start the browser playground (requires rigor-playground gem)",
48
+ "describe" => "Recommend the next skill for this project (alias for `skill describe`)",
49
+ "skill" => "Recommend the next skill + list/print bundled Agent Skills (skill describe, skill <name>)",
50
+ "docs" => "Print the bundled docs offline (docs <name>, docs --list)",
51
+ "show-bleedingedge" => "Show the bleeding-edge overlay + what your config adopts",
52
+ "doctor" => "Classify setup problems vs clean run with routed next actions",
53
+ "upgrade" => "Migration command skeleton (queued)",
54
+ "version" => "Print the Rigor version",
55
+ "help" => "Print this help, or a command's help (help <command>, help --format=json)"
56
+ }.freeze
57
+
58
+ # The commands whose `argv` is read by hand, so there is no parser to read: their switches, subcommands and
59
+ # formats are stated here. `playground` is delegated to the optional `rigor-playground` gem and is listed without
60
+ # flags.
61
+ DECLARED = {
62
+ "describe" => {
63
+ usage: "Usage: rigor describe [--deep]",
64
+ flags: [
65
+ { name: "--deep", arg: nil, desc: "Run `rigor check` first and route the recommendation on its result" }
66
+ ]
67
+ },
68
+ "docs" => {
69
+ usage: "Usage: rigor docs [<name>] [--path <name>] [--list [<category>]]",
70
+ flags: [
71
+ { name: "--path", arg: "NAME", desc: "Print the absolute path of a doc" },
72
+ { name: "--list", arg: "CATEGORY", optional: true, desc: "List bundled docs (optionally one category)" }
73
+ ]
74
+ },
75
+ "playground" => { usage: "Usage: rigor playground [options]" },
76
+ "version" => { usage: "Usage: rigor version" }
77
+ }.freeze
78
+
79
+ # The command files that build an `OptionParser`; the command class is the file's name in camel case.
80
+ PARSER_FILES = %w[
81
+ check annotate type_of lens trace type_scan effects explain diff sig_gen lsp mcp baseline triage coverage unused
82
+ plugins show_bleedingedge doctor skill plugin
83
+ ].to_h { |file| [file.tr("_", "-"), "#{file}_command"] }.freeze
84
+
85
+ # The commands that have no parser of their own at the top, so their usage is their `USAGE` constant.
86
+ USAGE_FILES = { "baseline" => "baseline_command", "upgrade" => "upgrade_command" }.freeze
87
+
88
+ Ractor.make_shareable(SUMMARIES)
89
+ Ractor.make_shareable(USAGE_FILES)
90
+ Ractor.make_shareable(DECLARED)
91
+ Ractor.make_shareable(PARSER_FILES)
92
+
93
+ module_function
94
+
95
+ # Every command name the CLI dispatches, in `rigor help` order.
96
+ def names
97
+ SUMMARIES.keys - BUILTINS + BUILTINS
98
+ end
99
+
100
+ # The `rigor help` text, rendered from {SUMMARIES} so its list is the catalogue's.
101
+ def help_text
102
+ width = names.map(&:length).max + 2
103
+ lines = names.map { |name| " #{name.ljust(width)}#{SUMMARIES.fetch(name)}" }
104
+ <<~HELP
105
+ Usage: rigor <command> [options]
106
+
107
+ Commands:
108
+ #{lines.join("\n")}
109
+
110
+ Run `rigor help <command>` (or `rigor <command> --help`) for a command's options.
111
+ Run `rigor describe` for the next step on this project, or `rigor help --format=json` for the full surface.
112
+ HELP
113
+ end
114
+
115
+ # All entries, as plain hashes ready for JSON.
116
+ def entries
117
+ names.map { |name| entry(name) }
118
+ end
119
+
120
+ # The document `rigor help --format=json` prints.
121
+ def document
122
+ { "schema_version" => SCHEMA_VERSION, "version" => Rigor::VERSION, "commands" => entries }
123
+ end
124
+
125
+ def entry(name)
126
+ declared = DECLARED.fetch(name, {})
127
+ parsed = parsed_entry(name)
128
+ {
129
+ "name" => name,
130
+ "summary" => SUMMARIES.fetch(name),
131
+ "usage" => declared[:usage] || parsed[:usage] || command_usage(name),
132
+ "subcommands" => parsed[:subcommands] || declared_subcommands(declared),
133
+ "flags" => parsed[:flags] || declared_flags(declared),
134
+ "formats" => parsed[:formats] || [],
135
+ "mcp_tool" => mcp_tool(name)
136
+ }
137
+ end
138
+
139
+ # The `OptionParser` view of a command: its own flags and formats at the top, and under `subcommands` the same
140
+ # shape for each subcommand's parser. A command with no parser of its own (`baseline`) has empty top-level
141
+ # `flags` and `formats`; none of them is a union over its subcommands.
142
+ def parsed_entry(name)
143
+ pairs = parser_pairs(name)
144
+ return {} if pairs.nil?
145
+
146
+ own = pairs.find { |sub, _| sub.nil? }&.last
147
+ subs = pairs.reject { |sub, _| sub.nil? }
148
+ top = own ? describe_parser(own) : { flags: [], formats: [] }
149
+ return top if subs.empty?
150
+
151
+ top.merge(subcommands: subs.map do |sub, parser|
152
+ { "name" => sub }.merge(stringify_keys(describe_parser(parser)))
153
+ end)
154
+ end
155
+
156
+ # The `[subcommand, parser]` pairs of a command (no name for its own parser), or nil when it has no parser.
157
+ def parser_pairs(name)
158
+ case name
159
+ when "init" then [[nil, CLI.init_option_parser]]
160
+ when "help" then [[nil, CLI.help_option_parser]]
161
+ else command_parser_pairs(name)
162
+ end
163
+ end
164
+
165
+ def command_parser_pairs(name)
166
+ file = PARSER_FILES[name]
167
+ return nil unless file
168
+
169
+ require_relative file
170
+ klass = CLI.const_get(file.split("_").map(&:capitalize).join)
171
+ case name
172
+ when "effects" then effects_parser_pairs(klass)
173
+ when "skill"
174
+ [[nil, klass.new(argv: []).option_parser],
175
+ ["describe", klass.describe_option_parser("Usage: rigor skill describe [--deep]")]]
176
+ when "baseline"
177
+ command = klass.new(argv: [])
178
+ klass::SUBCOMMANDS.map { |sub| [sub, command.option_parser(sub)] }
179
+ else [[nil, klass.new(argv: []).option_parser]]
180
+ end
181
+ end
182
+
183
+ def effects_parser_pairs(klass)
184
+ [[nil, klass.new(argv: []).option_parser]] +
185
+ EffectsSnapshotCommand::VERBS.map do |verb|
186
+ [verb, EffectsSnapshotCommand.new(argv: [], verb: verb).option_parser]
187
+ end
188
+ end
189
+
190
+ # The usage line of a command with no parser to take a banner from, read from the command's own `USAGE`.
191
+ def command_usage(name)
192
+ file = USAGE_FILES[name]
193
+ return nil unless file
194
+
195
+ require_relative file
196
+ CLI.const_get(file.split("_").map(&:capitalize).join)::USAGE
197
+ end
198
+
199
+ def declared_flags(declared)
200
+ (declared[:flags] || []).map do |flag|
201
+ { "name" => flag.fetch(:name), "arg" => flag.fetch(:arg), "optional" => flag.fetch(:optional, false),
202
+ "desc" => flag.fetch(:desc) }
203
+ end
204
+ end
205
+
206
+ def declared_subcommands(declared)
207
+ (declared[:subcommands] || []).map do |sub|
208
+ { "name" => sub.fetch(:name), "usage" => sub.fetch(:usage), "flags" => [], "formats" => [] }
209
+ end
210
+ end
211
+
212
+ # Reads usage, flags and formats from the switches of `parser`.
213
+ def describe_parser(parser)
214
+ flags = parser.top.list.flat_map { |switch| flags_of(switch) }
215
+ format_switch = parser.top.list.any? { |switch| switch.long.first == "--format" }
216
+ { usage: parser.banner.to_s.lines.first&.strip, flags: flags,
217
+ formats: format_switch ? Options.accepted_formats(parser) || [] : [] }
218
+ end
219
+
220
+ # A switch's literal flags: `--[no-]color` is the two flags `--color` and `--no-color`.
221
+ def flags_of(switch)
222
+ long = switch.long.first
223
+ return [] unless long
224
+
225
+ arg, optional = arg_of(switch.arg)
226
+ desc = switch.desc.join(" ")
227
+ flag_names(long).map { |flag| { "name" => flag, "arg" => arg, "optional" => optional, "desc" => desc } }
228
+ end
229
+
230
+ # `[arg, optional]`: `=[LIST]` is the argument `LIST`, optional.
231
+ def arg_of(raw)
232
+ arg = raw&.sub(/\A[= ]/, "")
233
+ optional = !arg.nil? && arg.start_with?("[") && arg.end_with?("]")
234
+ [optional ? arg[1..-2] : arg, optional]
235
+ end
236
+
237
+ def flag_names(long)
238
+ return [long] unless long.start_with?("--[no-]")
239
+
240
+ bare = long.delete_prefix("--[no-]")
241
+ ["--#{bare}", "--no-#{bare}"]
242
+ end
243
+
244
+ # `rigor_check` mirrors `check`, `rigor_sig_gen` mirrors `sig-gen`: a tool is named for its command.
245
+ def mcp_tool(name)
246
+ require_relative "../mcp/server"
247
+ tool = "rigor_#{name.tr('-', '_')}"
248
+ tool if MCP::Server::TOOLS.any? { |candidate| candidate.fetch(:name) == tool }
249
+ end
250
+
251
+ def stringify_keys(hash)
252
+ hash.transform_keys(&:to_s)
253
+ end
254
+ end
255
+ end
256
+ end
@@ -3,6 +3,7 @@
3
3
  require "fileutils"
4
4
  require "json"
5
5
  require "optionparser"
6
+ require "tempfile"
6
7
 
7
8
  require_relative "../configuration"
8
9
  require_relative "../config_audit"
@@ -11,12 +12,14 @@ require_relative "../analysis/rule_catalog"
11
12
  # The baseline filter runs on EVERY exit path — including the ADR-87 WD4 cache-HIT fast path, which skips
12
13
  # `load_check_dependencies` — so it must be a load-time require. It pulls only YAML, never the engine.
13
14
  require_relative "../analysis/baseline"
15
+ require_relative "../analysis/edit_replay"
14
16
  require_relative "command"
15
17
  require_relative "options"
16
18
  require_relative "diagnostic_formats"
17
19
  require_relative "../ci_detector"
20
+ require_relative "json_document"
18
21
  # ADR-87 WD4 — `coverage_scan` and `check_runner_factory` both pull the inference engine, so they are required
19
- # lazily (in `compute_coverage` / `build_check_runner`) rather than at load time: an ordinary check whose
22
+ # lazily (in `invoke_check` / `compute_coverage`) rather than at load time: an ordinary check whose
20
23
  # result the run-cache probe serves must reach the hit verdict without `rigor/inference` in $LOADED_FEATURES.
21
24
 
22
25
  module Rigor
@@ -90,6 +93,97 @@ module Rigor
90
93
  exit_code
91
94
  end
92
95
 
96
+ # The parser this command parses with, built without parsing anything: the catalogue reads the
97
+ # flags and formats from it (ADR-126 WD3). `options` is only written by the switches' blocks.
98
+ def option_parser(options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
99
+ OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
100
+ opts.banner = "Usage: rigor check [options] [paths]"
101
+ Options.add_config(opts, options)
102
+ Options.add_format(opts, options,
103
+ "Output format: text, json, sarif, github, gitlab, checkstyle, junit, teamcity",
104
+ formats: %w[text json] + DiagnosticFormats::FORMATS)
105
+ opts.on("--explain", "Surface fail-soft fallback events as :info diagnostics") { options[:explain] = true }
106
+ opts.on("--cache-stats", "Print on-disk cache inventory at end of run") { options[:cache_stats] = true }
107
+ opts.on("--coverage",
108
+ "Add a type-precision coverage block (an extra precision pass over the analyzed files)") do
109
+ options[:coverage] = true
110
+ end
111
+ opts.on("--clear-cache", "Remove the .rigor/cache directory before running") { options[:clear_cache] = true }
112
+ opts.on("--no-cache",
113
+ "Disable the persistent cache for this run (with --incremental: no snapshot is read or written)") do
114
+ options[:no_cache] = true
115
+ end
116
+ opts.on("--[no-]stats",
117
+ "Print run summary (files, classes, memory, wall time) to stderr (default: on)") do |value|
118
+ options[:stats] = value
119
+ end
120
+ opts.on("--workers=N", Integer,
121
+ "Dispatch per-file analysis across N Ractor workers (default: 0; sequential)") do |value|
122
+ options[:workers] = value
123
+ end
124
+ Options.add_editor_mode(opts, options)
125
+ opts.on("--baseline=PATH",
126
+ "load baseline from PATH (overrides .rigor.yml `baseline:`)") do |value|
127
+ options[:baseline] = value
128
+ end
129
+ opts.on("--no-baseline",
130
+ "ignore any configured baseline for this run") do
131
+ options[:baseline] = false
132
+ end
133
+ opts.on("--baseline-strict",
134
+ "fail the run on any baseline drift (CI gate)") do
135
+ options[:baseline_strict] = true
136
+ end
137
+ opts.on("--fail-on=SEVERITY",
138
+ "exit non-zero on a diagnostic at or above SEVERITY: error (default), warning, or info") do |value|
139
+ # Validated post-parse (`valid_fail_on_option?`, called from `run`) rather than here — see its
140
+ # comment for why an unrecognised value is not raised from inside this block.
141
+ options[:fail_on] = value.to_s.downcase.to_sym
142
+ end
143
+ opts.on("--treat-all-as-inline-rbs",
144
+ "force-load rigor-rbs-inline with require_magic_comment: false") do
145
+ options[:treat_all_as_inline_rbs] = true
146
+ end
147
+ opts.on("--verify-incremental",
148
+ "assert incremental analysis matches a full run, then exit") do
149
+ options[:verify_incremental] = true
150
+ end
151
+ opts.on("--verify-incremental-edits=N", Integer,
152
+ "with --verify-incremental, also replay edits (empty, class/module skeleton, up to 2 " \
153
+ "one-statement drops) on N files") do |value|
154
+ if value.negative?
155
+ raise OptionParser::InvalidArgument, "--verify-incremental-edits=#{value} (must be 0 or more)"
156
+ end
157
+
158
+ options[:verify_incremental] = true
159
+ options[:verify_incremental_edits] = value
160
+ end
161
+ opts.on("--incremental",
162
+ "re-analyze only files changed since the last run (cross-process cache)") do
163
+ options[:incremental] = true
164
+ end
165
+ opts.on("--no-ci-detect",
166
+ "do not auto-emit CI-native output when a CI environment is detected") do
167
+ options[:ci_detect] = false
168
+ end
169
+ # ADR-50 § WD2 — `=[LIST]` (not ` [LIST]`) so a bare `--bleeding-edge` never swallows a following positional
170
+ # path: `rigor check --bleeding-edge lib` adopts the whole overlay and checks `lib`.
171
+ opts.on("--bleeding-edge=[LIST]",
172
+ "adopt the bleeding-edge overlay for this run " \
173
+ "(all features, or a comma-separated feature-id list)") do |value|
174
+ options[:bleeding_edge] = value.nil? || value.split(",").map(&:strip).reject(&:empty?)
175
+ end
176
+ opts.on("--no-bleeding-edge",
177
+ "ignore any configured bleeding_edge: selection for this run") do
178
+ options[:bleeding_edge] = false
179
+ end
180
+ opts.on("--no-tolerated-effects",
181
+ "check effect envelopes as if effects.tolerated: were empty") do
182
+ options[:no_tolerated_effects] = true
183
+ end
184
+ end
185
+ end
186
+
93
187
  private
94
188
 
95
189
  # True when `diagnostics` (already baseline-filtered and severity-resolved — the same list
@@ -217,10 +311,9 @@ module Rigor
217
311
  exit_code
218
312
  end
219
313
 
220
- # ADR-46 — the two incremental-analysis check modes both fully handle the run and return an exit code (so `run`
221
- # short-circuits); returns nil for an ordinary check.
222
- # A nil return means "not a special mode" — `run` continues with the ordinary check. Editor mode option B
223
- # also returns nil when it declines (no reusable snapshot), so the run falls back to single-file scope.
314
+ # ADR-46 — the two incremental-analysis check modes handle the run and return its exit code, so `run`
315
+ # short-circuits. Returns nil for an ordinary check, and for editor mode option B when it declines (no reusable
316
+ # snapshot), so the run falls back to single-file scope.
224
317
  def dispatch_special_check_mode(configuration, options, cache_root, buffer)
225
318
  if options.fetch(:verify_incremental)
226
319
  # The gate compares an incremental recheck against a full-run oracle, and a buffer makes the two
@@ -272,8 +365,85 @@ module Rigor
272
365
  incremental = session.reanalyze_subset(subset).map(&:to_h)
273
366
  full = verify_full_diagnostics(configuration, paths, collect_stats: options.fetch(:stats)).map(&:to_h)
274
367
 
275
- report_verify_incremental(incremental, full, subset_size: subset.size, total: analyzed.size,
276
- format: options.fetch(:format))
368
+ status = report_verify_incremental(incremental, full, subset_size: subset.size, total: analyzed.size,
369
+ format: options.fetch(:format))
370
+ return status unless status.zero? && options.fetch(:verify_incremental_edits).positive?
371
+
372
+ verify_edit_replays(session, configuration, paths, options)
373
+ end
374
+
375
+ # Issue #1967 — the partition check above re-analyses an unchanged tree, so every served row is still right and a
376
+ # missing invalidation edge goes unseen. Here each of `--verify-incremental-edits` sampled files is edited through
377
+ # an editor buffer (never on disk) by each of {Analysis::EditReplay.edits} — emptied, reduced to its
378
+ # `class` / `module` skeleton, and (#2277) with one body statement dropped, at most
379
+ # {Analysis::EditReplay::MAX_DROPS} times — and the warm recheck of the baseline
380
+ # ({IncrementalSession#replay_edit}) must equal
381
+ # a full analysis of the edited tree: a dependent the recheck failed to re-analyse is served from the baseline and
382
+ # differs. A run in which every replay declined compared nothing, so it fails rather than report OK.
383
+ def verify_edit_replays(session, configuration, paths, options)
384
+ sample = edit_replay_sample(session.analyzed_files, options.fetch(:verify_incremental_edits))
385
+ replayed = 0
386
+ declined = 0
387
+ sample.each do |path|
388
+ Analysis::EditReplay.edits(File.read(path)).each do |edit|
389
+ incremental, full = replay_edit(session, configuration, paths, path, edit)
390
+ next declined += 1 if incremental.nil?
391
+
392
+ replayed += 1
393
+ next if incremental == full
394
+
395
+ return report_edit_replay_mismatch(path, edit, incremental, full)
396
+ end
397
+ end
398
+ report_edit_replays(replayed, declined, options.fetch(:format))
399
+ end
400
+
401
+ def report_edit_replay_mismatch(path, edit, incremental, full)
402
+ @err.puts("rigor: --verify-incremental FAILED — the recheck after #{edit.label} #{path} " \
403
+ "differs from a full run.")
404
+ return report_verify_order_mismatch(incremental, full) if incremental.tally == full.tally
405
+
406
+ report_verify_set_mismatch(incremental, full, header: false)
407
+ end
408
+
409
+ # `count` files spread evenly over the analysed list, so a small count still reaches both ends of it.
410
+ def edit_replay_sample(analyzed, count)
411
+ return analyzed if count >= analyzed.size
412
+
413
+ Array.new(count) { |index| analyzed[index * analyzed.size / count] }
414
+ end
415
+
416
+ # The warm recheck's rows and a full run's, both with `path` replaced by `edit`; `[nil, nil]` when the recheck
417
+ # declined.
418
+ def replay_edit(session, configuration, paths, path, edit)
419
+ Tempfile.create(["rigor-verify-edit-", ".rb"]) do |file|
420
+ file.write(edit.source)
421
+ file.close
422
+ buffer = Analysis::BufferBinding.new(logical_path: path, physical_path: file.path)
423
+ recheck = session.replay_edit(buffer)
424
+ return [nil, nil] if recheck.nil?
425
+
426
+ # `analyze_only:` with the buffer selects editor mode option B, a whole-project run reading the buffer at
427
+ # its logical path; the buffer alone would analyse that one file.
428
+ runner = Analysis::Runner.new(configuration: configuration, cache_store: nil, collect_stats: false,
429
+ buffer: buffer, analyze_only: session.analyzed_files.to_set)
430
+ full = paths ? runner.run(paths) : runner.run
431
+ [recheck.diagnostics.map(&:to_h), full.diagnostics.map(&:to_h)]
432
+ end
433
+ end
434
+
435
+ def report_edit_replays(replayed, declined, format)
436
+ if replayed.zero? && declined.positive?
437
+ @err.puts("rigor: --verify-incremental FAILED — every edit replay (#{declined}) declined, " \
438
+ "since the recheck would have been a full analysis, so no edit was compared.")
439
+ return 1
440
+ end
441
+
442
+ line = "rigor: --verify-incremental OK — #{replayed} edits replayed (files emptied, reduced to their " \
443
+ "class/module skeleton, and with a body statement dropped), every recheck matches full"
444
+ line = "#{line}; #{declined} declined (the recheck would have been a full analysis)" if declined.positive?
445
+ side_output(format).puts(line)
446
+ 0
277
447
  end
278
448
 
279
449
  # ADR-46 — cross-process incremental analysis (`--incremental`). Derives the global fingerprint cheaply (no RBS
@@ -309,9 +479,7 @@ module Rigor
309
479
  return run_editor_mode_option_b(session, snapshot, fingerprint, configuration, options) if buffer
310
480
 
311
481
  diagnostics, warm = session.run_incremental(snapshot: snapshot, fingerprint: fingerprint)
312
- # The banner's file count comes from the session's analyzed set (cold analyses all; a warm recheck's
313
- # `@analyzed` advances to the current file set), so a dedicated probe Runner + `Dir.glob` is no longer
314
- # built just to size the banner (recon §3 — the analysis tree was expanded three times per recheck).
482
+ # The banner's file count comes from the session's analyzed set, so no probe Runner is built just to size it.
315
483
  # A warm banner reports the recheck's own sets (#1526), which only the session knows.
316
484
  report_incremental_run(warm, session.analyzed_files.size, recheck: session.last_recheck)
317
485
  emit_incremental_fact_surface_notes(session)
@@ -490,10 +658,10 @@ module Rigor
490
658
  end
491
659
  end
492
660
 
493
- def report_verify_set_mismatch(incremental, full)
661
+ def report_verify_set_mismatch(incremental, full, header: true)
494
662
  only_incremental = multiset_difference(incremental, full)
495
663
  only_full = multiset_difference(full, incremental)
496
- @err.puts("rigor: --verify-incremental FAILED — incremental and full diagnostics differ.")
664
+ @err.puts("rigor: --verify-incremental FAILED — incremental and full diagnostics differ.") if header
497
665
  @err.puts(" incremental-only: #{only_incremental.size}, full-only: #{only_full.size}")
498
666
  (only_incremental + only_full).first(10).each do |hash|
499
667
  @err.puts(" #{diagnostic_location(hash)}")
@@ -611,7 +779,7 @@ module Rigor
611
779
  )
612
780
  end
613
781
 
614
- def parse_check_options # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
782
+ def parse_check_options
615
783
  options = {
616
784
  config: nil,
617
785
  format: "text",
@@ -621,7 +789,7 @@ module Rigor
621
789
  no_cache: false,
622
790
  stats: true,
623
791
  # ADR-15 Phase 4c — when nil, falls back to `RIGOR_RACTOR_WORKERS` then `.rigor.yml` `parallel.workers:` then
624
- # 0 (sequential). See `resolve_workers` for the precedence chain.
792
+ # 0 (sequential). See `CheckRunnerFactory.resolve_workers` for the precedence chain.
625
793
  workers: nil,
626
794
  tmp_file: nil,
627
795
  instead_of: nil,
@@ -643,6 +811,9 @@ module Rigor
643
811
  # the rest from the per-file cache, and asserts the merged diagnostics are byte-identical to a full
644
812
  # `--no-cache` run. Exits non-zero on any mismatch. Off by default.
645
813
  verify_incremental: false,
814
+ # Issue #1967 — the number of files `--verify-incremental` replays an edit on (each emptied through an editor
815
+ # buffer) after the partition check. 0 replays none.
816
+ verify_incremental_edits: 0,
646
817
  # ADR-46 — cross-process incremental analysis. With a disk snapshot of the prior run's per-file diagnostics +
647
818
  # dependency graph, re-analyzes only the changed closure and serves the rest from the snapshot. Off by
648
819
  # default.
@@ -667,84 +838,7 @@ module Rigor
667
838
  # one-line coverage summary.
668
839
  coverage: false
669
840
  }
670
- parser = OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
671
- opts.banner = "Usage: rigor check [options] [paths]"
672
- Options.add_config(opts, options)
673
- opts.on("--format=FORMAT",
674
- "Output format: text, json, sarif, github, gitlab, checkstyle, junit, teamcity") do |value|
675
- options[:format] = value
676
- end
677
- opts.on("--explain", "Surface fail-soft fallback events as :info diagnostics") { options[:explain] = true }
678
- opts.on("--cache-stats", "Print on-disk cache inventory at end of run") { options[:cache_stats] = true }
679
- opts.on("--coverage",
680
- "Add a type-precision coverage block (an extra precision pass over the analyzed files)") do
681
- options[:coverage] = true
682
- end
683
- opts.on("--clear-cache", "Remove the .rigor/cache directory before running") { options[:clear_cache] = true }
684
- opts.on("--no-cache",
685
- "Disable the persistent cache for this run (with --incremental: no snapshot is read or written)") do
686
- options[:no_cache] = true
687
- end
688
- opts.on("--[no-]stats",
689
- "Print run summary (files, classes, memory, wall time) to stderr (default: on)") do |value|
690
- options[:stats] = value
691
- end
692
- opts.on("--workers=N", Integer,
693
- "Dispatch per-file analysis across N Ractor workers (default: 0; sequential)") do |value|
694
- options[:workers] = value
695
- end
696
- Options.add_editor_mode(opts, options)
697
- opts.on("--baseline=PATH",
698
- "load baseline from PATH (overrides .rigor.yml `baseline:`)") do |value|
699
- options[:baseline] = value
700
- end
701
- opts.on("--no-baseline",
702
- "ignore any configured baseline for this run") do
703
- options[:baseline] = false
704
- end
705
- opts.on("--baseline-strict",
706
- "fail the run on any baseline drift (CI gate)") do
707
- options[:baseline_strict] = true
708
- end
709
- opts.on("--fail-on=SEVERITY",
710
- "exit non-zero on a diagnostic at or above SEVERITY: error (default), warning, or info") do |value|
711
- # Validated post-parse (`valid_fail_on_option?`, called from `run`) rather than here — see its
712
- # comment for why an unrecognised value is not raised from inside this block.
713
- options[:fail_on] = value.to_s.downcase.to_sym
714
- end
715
- opts.on("--treat-all-as-inline-rbs",
716
- "force-load rigor-rbs-inline with require_magic_comment: false") do
717
- options[:treat_all_as_inline_rbs] = true
718
- end
719
- opts.on("--verify-incremental",
720
- "assert incremental analysis matches a full run, then exit") do
721
- options[:verify_incremental] = true
722
- end
723
- opts.on("--incremental",
724
- "re-analyze only files changed since the last run (cross-process cache)") do
725
- options[:incremental] = true
726
- end
727
- opts.on("--no-ci-detect",
728
- "do not auto-emit CI-native output when a CI environment is detected") do
729
- options[:ci_detect] = false
730
- end
731
- # ADR-50 § WD2 — `=[LIST]` (not ` [LIST]`) so a bare `--bleeding-edge` never swallows a following positional
732
- # path: `rigor check --bleeding-edge lib` adopts the whole overlay and checks `lib`.
733
- opts.on("--bleeding-edge=[LIST]",
734
- "adopt the bleeding-edge overlay for this run " \
735
- "(all features, or a comma-separated feature-id list)") do |value|
736
- options[:bleeding_edge] = value.nil? || value.split(",").map(&:strip).reject(&:empty?)
737
- end
738
- opts.on("--no-bleeding-edge",
739
- "ignore any configured bleeding_edge: selection for this run") do
740
- options[:bleeding_edge] = false
741
- end
742
- opts.on("--no-tolerated-effects",
743
- "check effect envelopes as if effects.tolerated: were empty") do
744
- options[:no_tolerated_effects] = true
745
- end
746
- end
747
- parser.parse!(@argv)
841
+ option_parser(options).parse!(@argv)
748
842
  options
749
843
  end
750
844
 
@@ -854,6 +948,7 @@ module Rigor
854
948
  @err.puts(" recursion-unroll-fuel hits: #{counts[Inference::BudgetTrace::RECURSION_UNROLL_FUEL]}")
855
949
  @err.puts(" recursion-fixpoint-cap hits: #{counts[Inference::BudgetTrace::RECURSION_FIXPOINT_CAP]}")
856
950
  @err.puts(" block-writeback-cap hits: #{counts[Inference::BudgetTrace::BLOCK_WRITEBACK_CAP]}")
951
+ @err.puts(" callee-chain-cap hits: #{counts[Inference::BudgetTrace::CALLEE_CHAIN_CAP]}")
857
952
  write_budget_distributions
858
953
  write_memo_profile(counts)
859
954
  end
@@ -1064,7 +1159,7 @@ module Rigor
1064
1159
  payload["fail_on"] = fail_on.to_s
1065
1160
  payload["coverage"] = coverage_payload(coverage) if coverage
1066
1161
  payload["config_warnings"] = config_warnings.map(&:to_h) unless config_warnings.empty?
1067
- @out.puts(JSON.pretty_generate(payload))
1162
+ @out.puts(JSON.pretty_generate(JsonDocument.stamp(payload)))
1068
1163
  when "text"
1069
1164
  write_text_result(result)
1070
1165
  write_coverage_summary(coverage) if coverage
@@ -7,8 +7,8 @@ module Rigor
7
7
  class CLI
8
8
  # Shared factory for building an {Analysis::Runner} from CLI option hashes + a loaded {Configuration}.
9
9
  #
10
- # Extracted from {CheckCommand} so that `rigor doctor` and future `describe --deep` can reuse the exact same
11
- # runner-setup logic (cache, workers, buffer, explain) without diverging from the primary check path (ADR-77 WD3).
10
+ # Extracted from {CheckCommand} so that other commands (`rigor doctor`, `rigor skill describe --deep`) reuse the
11
+ # same runner setup (cache, workers, buffer, explain) instead of diverging from the `rigor check` path (ADR-77 WD3).
12
12
  module CheckRunnerFactory
13
13
  module_function
14
14