rigortype 0.3.9 → 0.4.1
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.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/data/core_overlay/enumerable.rbs +51 -0
- data/data/core_overlay/enumerator.rbs +84 -0
- data/data/core_overlay/hash_rbs3.rbs +41 -0
- data/data/core_overlay/process.rbs +40 -0
- data/data/core_overlay/string_io.rbs +33 -0
- data/data/effects/core.yml +3 -3
- data/data/gem_overlay/activesupport/core_ext.rbs +127 -4
- data/docs/handbook/03-narrowing.md +95 -10
- data/docs/handbook/04-tuples-and-shapes.md +8 -6
- data/docs/handbook/07-rbs-and-extended.md +16 -11
- data/docs/handbook/08-understanding-errors.md +3 -2
- data/docs/handbook/10-sorbet.md +9 -10
- data/docs/handbook/11-sig-gen.md +454 -13
- data/docs/install.md +87 -15
- data/docs/manual/02-cli-reference.md +65 -4
- data/docs/manual/03-configuration.md +12 -0
- data/docs/manual/04-diagnostics.md +4 -0
- data/docs/manual/07-plugins.md +1 -1
- data/docs/manual/08-skills.md +4 -3
- data/docs/manual/10-mcp-server.md +3 -2
- data/docs/manual/12-caching.md +43 -4
- data/docs/manual/14-rails-quickstart.md +19 -11
- data/docs/manual/16-rbs-extended-annotations.md +40 -7
- data/docs/manual/19-effect-labels.md +10 -0
- data/docs/manual/plugins/README.md +7 -0
- data/docs/manual/plugins/rigor-actioncable.md +8 -1
- data/docs/manual/plugins/rigor-actionmailer.md +7 -0
- data/docs/manual/plugins/rigor-actionpack.md +243 -0
- data/docs/manual/plugins/rigor-active-model-serializers.md +153 -0
- data/docs/manual/plugins/rigor-activejob.md +7 -0
- data/docs/manual/plugins/rigor-activerecord.md +110 -4
- data/docs/manual/plugins/rigor-activestorage.md +8 -1
- data/docs/manual/plugins/rigor-activesupport-core-ext.md +11 -5
- data/docs/manual/plugins/rigor-grape.md +106 -0
- data/docs/manual/plugins/rigor-graphql.md +23 -2
- data/docs/manual/plugins/rigor-pundit.md +8 -1
- data/docs/manual/plugins/rigor-rails-i18n.md +10 -5
- data/docs/manual/plugins/rigor-rails-routes.md +7 -0
- data/docs/manual/plugins/rigor-rbs-inline.md +212 -25
- data/docs/manual/plugins/rigor-sidekiq.md +8 -1
- data/docs/manual/plugins/rigor-sorbet.md +21 -5
- data/exe/rigor +19 -4
- data/lib/rigor/analysis/baseline.rb +1 -1
- data/lib/rigor/analysis/check_rules/declaration_sourced_guard.rb +167 -2
- data/lib/rigor/analysis/check_rules/lexical_method_sites.rb +189 -0
- data/lib/rigor/analysis/check_rules/main_pass_collector.rb +5 -3
- data/lib/rigor/analysis/check_rules/rule_ids.rb +20 -5
- data/lib/rigor/analysis/check_rules/rule_walk.rb +2 -1
- data/lib/rigor/analysis/check_rules/source_arity.rb +427 -0
- data/lib/rigor/analysis/check_rules/special_global_setters.rb +146 -0
- data/lib/rigor/analysis/check_rules/unreachable_clause_collector.rb +36 -2
- data/lib/rigor/analysis/check_rules.rb +638 -136
- data/lib/rigor/analysis/dependency_recorder.rb +222 -17
- data/lib/rigor/analysis/fact_store.rb +9 -0
- data/lib/rigor/analysis/incremental.rb +26 -0
- data/lib/rigor/analysis/incremental_run_slot/write_guard.rb +266 -0
- data/lib/rigor/analysis/incremental_run_slot.rb +171 -0
- data/lib/rigor/analysis/incremental_session.rb +309 -53
- data/lib/rigor/analysis/plugin_fact_fingerprint.rb +24 -13
- data/lib/rigor/analysis/project_scan.rb +11 -1
- data/lib/rigor/analysis/reachability/plugin_roots.rb +0 -1
- data/lib/rigor/analysis/reachability/scan_cache.rb +3 -1
- data/lib/rigor/analysis/rule_catalog.rb +127 -0
- data/lib/rigor/analysis/run_cache_key.rb +46 -18
- data/lib/rigor/analysis/run_stats.rb +2 -2
- data/lib/rigor/analysis/runner/diagnostic_aggregator.rb +168 -12
- data/lib/rigor/analysis/runner/effect_envelope_pass.rb +9 -4
- data/lib/rigor/analysis/runner/pool_coordinator.rb +109 -17
- data/lib/rigor/analysis/runner/project_pre_passes.rb +44 -17
- data/lib/rigor/analysis/runner.rb +603 -54
- data/lib/rigor/analysis/shadow_harness.rb +27 -0
- data/lib/rigor/analysis/source_rbs_gate.rb +157 -0
- data/lib/rigor/analysis/template_unit_collector.rb +303 -0
- data/lib/rigor/analysis/template_unit_paths.rb +93 -0
- data/lib/rigor/analysis/template_unit_positions.rb +293 -0
- data/lib/rigor/analysis/template_units.rb +409 -0
- data/lib/rigor/analysis/worker_session.rb +57 -13
- data/lib/rigor/bleeding_edge.rb +0 -2
- data/lib/rigor/builtins/hkt_builtins.rb +1 -0
- data/lib/rigor/builtins/imported_refinements.rb +4 -0
- data/lib/rigor/builtins/regex_refinement.rb +17 -9
- data/lib/rigor/builtins/static_return_refinements.rb +2 -0
- data/lib/rigor/cache/descriptor.rb +45 -1
- data/lib/rigor/cache/engine_source.rb +29 -1
- data/lib/rigor/cache/file_digest.rb +28 -0
- data/lib/rigor/cache/incremental_snapshot.rb +102 -8
- data/lib/rigor/cache/rbs_cache_producer.rb +4 -0
- data/lib/rigor/cache/rbs_descriptor.rb +37 -7
- data/lib/rigor/cache/store.rb +63 -4
- data/lib/rigor/cache/value_digest.rb +325 -0
- data/lib/rigor/ci_detector.rb +1 -0
- data/lib/rigor/cli/check_command.rb +83 -13
- data/lib/rigor/cli/doc_links.rb +1 -1
- data/lib/rigor/cli/docs_command.rb +4 -4
- data/lib/rigor/cli/doctor_command.rb +1 -1
- data/lib/rigor/cli/effects_report.rb +2 -2
- data/lib/rigor/cli/plugin_command.rb +3 -3
- data/lib/rigor/cli/prism_colorizer.rb +0 -1
- data/lib/rigor/cli/sig_gen_command.rb +210 -29
- data/lib/rigor/cli/skill_command.rb +1 -1
- data/lib/rigor/cli/skill_describe.rb +0 -1
- data/lib/rigor/cli/type_of_command.rb +19 -5
- data/lib/rigor/cli/type_of_renderer.rb +20 -9
- data/lib/rigor/cli/type_of_template_probe.rb +189 -0
- data/lib/rigor/cli/unused_command.rb +3 -3
- data/lib/rigor/cli.rb +21 -3
- data/lib/rigor/config_audit.rb +3 -2
- data/lib/rigor/config_path.rb +29 -0
- data/lib/rigor/configuration/severity_profile.rb +24 -3
- data/lib/rigor/configuration.rb +71 -7
- data/lib/rigor/effects/ancestry_recorder.rb +191 -0
- data/lib/rigor/effects/attribution.rb +11 -2
- data/lib/rigor/effects/callee_rule.rb +368 -0
- data/lib/rigor/effects/catalog.rb +7 -4
- data/lib/rigor/effects/collector.rb +11 -5
- data/lib/rigor/effects/config_envelopes.rb +9 -2
- data/lib/rigor/effects/definition_context.rb +179 -0
- data/lib/rigor/effects/effect_table.rb +11 -3
- data/lib/rigor/effects/envelope_check.rb +1 -1
- data/lib/rigor/effects/envelope_index.rb +15 -0
- data/lib/rigor/effects/file_collection.rb +59 -5
- data/lib/rigor/effects/framework_units.rb +1 -1
- data/lib/rigor/effects/identity.rb +16 -0
- data/lib/rigor/effects/local_ownership.rb +38 -12
- data/lib/rigor/effects/method_key.rb +21 -0
- data/lib/rigor/effects/mutation_classifier.rb +23 -12
- data/lib/rigor/effects/plugin_facts.rb +49 -37
- data/lib/rigor/effects/propagator.rb +295 -16
- data/lib/rigor/effects/registry.rb +1 -1
- data/lib/rigor/effects/scanner.rb +121 -72
- data/lib/rigor/effects/signature_sources.rb +1 -1
- data/lib/rigor/effects/snapshot.rb +2 -1
- data/lib/rigor/effects/summary.rb +27 -4
- data/lib/rigor/effects/unit_scan.rb +385 -30
- data/lib/rigor/effects/visibility.rb +101 -0
- data/lib/rigor/environment/bundle_sig_discovery.rb +5 -3
- data/lib/rigor/environment/lockfile_resolver.rb +27 -1
- data/lib/rigor/environment/member_consistency/comparator.rb +708 -0
- data/lib/rigor/environment/member_consistency.rb +298 -0
- data/lib/rigor/environment/rbs_collection_discovery.rb +10 -1
- data/lib/rigor/environment/rbs_loader.rb +400 -134
- data/lib/rigor/environment/source_rbs_synthesis.rb +147 -0
- data/lib/rigor/environment.rb +104 -96
- data/lib/rigor/hashing/xxh3.rb +264 -0
- data/lib/rigor/inference/acceptance.rb +139 -9
- data/lib/rigor/inference/block_auto_splat.rb +216 -0
- data/lib/rigor/inference/block_call_timing.rb +338 -0
- data/lib/rigor/inference/block_parameter_binder.rb +88 -26
- data/lib/rigor/inference/block_repetition.rb +71 -0
- data/lib/rigor/inference/body_fixpoint.rb +2 -1
- data/lib/rigor/inference/budget_trace.rb +2 -1
- data/lib/rigor/inference/builtins/method_catalog.rb +2 -1
- data/lib/rigor/inference/builtins/string_catalog.rb +1 -1
- data/lib/rigor/inference/captured_locals.rb +393 -15
- data/lib/rigor/inference/closure_escape_analyzer.rb +157 -13
- data/lib/rigor/inference/content_join.rb +200 -27
- data/lib/rigor/inference/declaration_walk/context.rb +195 -0
- data/lib/rigor/inference/declaration_walk/errors.rb +18 -0
- data/lib/rigor/inference/declaration_walk/shadow.rb +147 -0
- data/lib/rigor/inference/declaration_walk/traversal.rb +441 -0
- data/lib/rigor/inference/declaration_walk.rb +7 -0
- data/lib/rigor/inference/def_node_resolver.rb +3 -2
- data/lib/rigor/inference/def_return_typer.rb +11 -7
- data/lib/rigor/inference/define_method_block_self.rb +64 -0
- data/lib/rigor/inference/definer_resolution.rb +266 -0
- data/lib/rigor/inference/element_read_widening.rb +22 -10
- data/lib/rigor/inference/error_info.rb +196 -0
- data/lib/rigor/inference/expression_typer.rb +1665 -538
- data/lib/rigor/inference/external_ancestor_resolution.rb +264 -0
- data/lib/rigor/inference/fresh_frame_blocks.rb +127 -0
- data/lib/rigor/inference/global_write_census.rb +239 -0
- data/lib/rigor/inference/guard_rebinding.rb +488 -0
- data/lib/rigor/inference/hash_lookup_mutation.rb +88 -0
- data/lib/rigor/inference/index_write_widening.rb +16 -3
- data/lib/rigor/inference/indexed_narrowing.rb +61 -9
- data/lib/rigor/inference/jump_targets.rb +82 -0
- data/lib/rigor/inference/last_line/implicit_self.rb +210 -0
- data/lib/rigor/inference/last_line/self_evidence.rb +329 -0
- data/lib/rigor/inference/last_line.rb +340 -0
- data/lib/rigor/inference/last_status.rb +144 -0
- data/lib/rigor/inference/macro_block_self_type.rb +179 -17
- data/lib/rigor/inference/match_rebinding/calls.rb +281 -0
- data/lib/rigor/inference/match_rebinding/frame.rb +148 -0
- data/lib/rigor/inference/match_rebinding/operands.rb +236 -0
- data/lib/rigor/inference/match_rebinding/self_calls.rb +83 -0
- data/lib/rigor/inference/match_rebinding.rb +392 -0
- data/lib/rigor/inference/method_dispatcher/alias_strict_nominals.rb +36 -0
- data/lib/rigor/inference/method_dispatcher/block_folding.rb +85 -24
- data/lib/rigor/inference/method_dispatcher/facet_distribution.rb +147 -0
- data/lib/rigor/inference/method_dispatcher/hash_transform_keys_folding.rb +191 -0
- data/lib/rigor/inference/method_dispatcher/iterator_dispatch.rb +4 -0
- data/lib/rigor/inference/method_dispatcher/match_data_folding.rb +159 -0
- data/lib/rigor/inference/method_dispatcher/overload_selector.rb +113 -73
- data/lib/rigor/inference/method_dispatcher/process_folding.rb +56 -0
- data/lib/rigor/inference/method_dispatcher/proven_overload.rb +72 -0
- data/lib/rigor/inference/method_dispatcher/rbs_dispatch.rb +901 -38
- data/lib/rigor/inference/method_dispatcher/self_substitute.rb +142 -0
- data/lib/rigor/inference/method_dispatcher/shape_dispatch.rb +128 -53
- data/lib/rigor/inference/method_dispatcher/struct_folding.rb +1 -1
- data/lib/rigor/inference/method_dispatcher.rb +214 -13
- data/lib/rigor/inference/method_parameter_binder.rb +8 -3
- data/lib/rigor/inference/module_function_state.rb +213 -0
- data/lib/rigor/inference/multi_target_binder.rb +345 -52
- data/lib/rigor/inference/mutation_rejoin.rb +4 -1
- data/lib/rigor/inference/mutation_widening.rb +70 -48
- data/lib/rigor/inference/narrowing.rb +674 -124
- data/lib/rigor/inference/operand_effects.rb +167 -0
- data/lib/rigor/inference/operand_walk.rb +88 -0
- data/lib/rigor/inference/optimistic_origin.rb +152 -9
- data/lib/rigor/inference/parameter_inference_collector.rb +13 -11
- data/lib/rigor/inference/project_method_ownership.rb +136 -0
- data/lib/rigor/inference/project_patched_methods.rb +7 -2
- data/lib/rigor/inference/project_patched_scanner.rb +7 -3
- data/lib/rigor/inference/receiver_alias.rb +90 -1
- data/lib/rigor/inference/receiver_blind_block.rb +219 -0
- data/lib/rigor/inference/refinement_mutation.rb +15 -11
- data/lib/rigor/inference/repeated_or_writes.rb +463 -0
- data/lib/rigor/inference/return_barrier.rb +54 -0
- data/lib/rigor/inference/rewrite_mutation.rb +120 -0
- data/lib/rigor/inference/scope_indexer/certainty.rb +176 -0
- data/lib/rigor/inference/scope_indexer/class_cvars_collector.rb +35 -0
- data/lib/rigor/inference/scope_indexer/def_nestings_collector.rb +47 -0
- data/lib/rigor/inference/scope_indexer/layered_def_nestings.rb +36 -0
- data/lib/rigor/inference/scope_indexer/member_layouts_collector.rb +61 -0
- data/lib/rigor/inference/scope_indexer/mixin_accumulator.rb +130 -0
- data/lib/rigor/inference/scope_indexer/superclasses_collector.rb +64 -0
- data/lib/rigor/inference/scope_indexer.rb +5913 -701
- data/lib/rigor/inference/singleton_hook_decline.rb +253 -0
- data/lib/rigor/inference/statement_evaluator.rb +3249 -497
- data/lib/rigor/inference/stored_block_call.rb +54 -0
- data/lib/rigor/inference/string_mutation.rb +44 -7
- data/lib/rigor/inference/unknown_store_widening.rb +200 -0
- data/lib/rigor/inference/unthreaded_rebinds.rb +282 -0
- data/lib/rigor/language_server/debouncer.rb +0 -1
- data/lib/rigor/language_server/diagnostic_publisher.rb +3 -2
- data/lib/rigor/language_server/hover_renderer.rb +3 -3
- data/lib/rigor/language_server/project_context.rb +5 -3
- data/lib/rigor/mcp/server.rb +2 -1
- data/lib/rigor/plugin/base.rb +196 -13
- data/lib/rigor/plugin/box_probe.rb +91 -0
- data/lib/rigor/plugin/bundled_catalog.rb +1 -1
- data/lib/rigor/plugin/effect_attribution.rb +58 -4
- data/lib/rigor/plugin/io_boundary.rb +82 -4
- data/lib/rigor/plugin/isolation.rb +1 -1
- data/lib/rigor/plugin/loader.rb +2 -1
- data/lib/rigor/plugin/macro/block_as_method.rb +45 -6
- data/lib/rigor/plugin/manifest.rb +71 -10
- data/lib/rigor/plugin/registry.rb +35 -1
- data/lib/rigor/plugin/source_rbs_synthesis_reporter.rb +9 -3
- data/lib/rigor/plugin/template_unit.rb +196 -0
- data/lib/rigor/plugin/trust_policy.rb +3 -3
- data/lib/rigor/plugin.rb +1 -0
- data/lib/rigor/protection/discovery_seed.rb +20 -9
- data/lib/rigor/protection/kill_signature.rb +0 -1
- data/lib/rigor/protection/mutation_cache.rb +4 -5
- data/lib/rigor/rbs_extended.rb +27 -0
- data/lib/rigor/reflection/constant_ancestors.rb +146 -0
- data/lib/rigor/reflection/constant_path.rb +41 -13
- data/lib/rigor/reflection.rb +73 -107
- data/lib/rigor/scope/discovery_index.rb +351 -2
- data/lib/rigor/scope/resolution_chain/relevance.rb +165 -0
- data/lib/rigor/scope/resolution_chain.rb +884 -0
- data/lib/rigor/scope.rb +981 -198
- data/lib/rigor/sig_gen/alias_index.rb +289 -0
- data/lib/rigor/sig_gen/classification.rb +22 -5
- data/lib/rigor/sig_gen/declaration_equivalence.rb +127 -0
- data/lib/rigor/sig_gen/effect_annotation.rb +202 -0
- data/lib/rigor/sig_gen/generator.rb +580 -47
- data/lib/rigor/sig_gen/inline_declarations.rb +184 -0
- data/lib/rigor/sig_gen/method_candidate.rb +47 -3
- data/lib/rigor/sig_gen/observation_collector.rb +1 -1
- data/lib/rigor/sig_gen/renderer.rb +124 -9
- data/lib/rigor/sig_gen/skip_reason_catalog.rb +44 -1
- data/lib/rigor/sig_gen/write_result.rb +19 -3
- data/lib/rigor/sig_gen/writer.rb +166 -35
- data/lib/rigor/sig_gen.rb +3 -0
- data/lib/rigor/signature_path_audit.rb +1 -1
- data/lib/rigor/source/node_walker.rb +0 -3
- data/lib/rigor/source/parameter_envelope.rb +72 -0
- data/lib/rigor/source.rb +1 -0
- data/lib/rigor/type/combinator.rb +112 -12
- data/lib/rigor/type/difference.rb +1 -0
- data/lib/rigor/type/hash_shape.rb +1 -1
- data/lib/rigor/type/refined.rb +1 -0
- data/lib/rigor/version.rb +1 -1
- data/lib/rigor.rb +1 -0
- data/plugins/rigor-actioncable/lib/rigor/plugin/actioncable/effects.rb +1 -0
- data/plugins/rigor-actioncable/lib/rigor/plugin/actioncable.rb +9 -5
- data/plugins/rigor-actionmailer/lib/rigor/plugin/actionmailer.rb +13 -4
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/analyzer.rb +0 -1
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/controller_scan.rb +96 -0
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/effects.rb +65 -8
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/erb_compiler.rb +270 -0
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/render_locals.rb +402 -0
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/view_assigns.rb +370 -0
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack/view_units.rb +132 -0
- data/plugins/rigor-actionpack/lib/rigor/plugin/actionpack.rb +239 -4
- data/plugins/rigor-actionpack/sig/action_view.rbs +43 -0
- data/plugins/rigor-active-model-serializers/lib/rigor/plugin/active_model_serializers/serializer_discoverer.rb +220 -0
- data/plugins/rigor-active-model-serializers/lib/rigor/plugin/active_model_serializers/serializer_index.rb +56 -0
- data/plugins/rigor-active-model-serializers/lib/rigor/plugin/active_model_serializers.rb +263 -0
- data/plugins/rigor-active-model-serializers/lib/rigor-active-model-serializers.rb +7 -0
- data/plugins/rigor-active-model-serializers/sig/active_model_serializers.rbs +45 -0
- data/plugins/rigor-activejob/lib/rigor/plugin/activejob/effects.rb +1 -0
- data/plugins/rigor-activejob/lib/rigor/plugin/activejob.rb +9 -5
- data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/analyzer.rb +35 -3
- data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/effects.rb +72 -12
- data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/model_discoverer.rb +380 -3
- data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord/model_index.rb +14 -6
- data/plugins/rigor-activerecord/lib/rigor/plugin/activerecord.rb +281 -35
- data/plugins/rigor-activerecord/sig/active_record/relation.rbs +206 -31
- data/plugins/rigor-activestorage/lib/rigor/plugin/activestorage.rb +25 -14
- data/plugins/rigor-activesupport-core-ext/lib/rigor/plugin/activesupport_core_ext/effects.rb +9 -2
- data/plugins/rigor-activesupport-core-ext/sig/active_support/core_ext.rbs +171 -5
- data/plugins/rigor-dry-monads/lib/rigor/plugin/dry_monads.rb +2 -0
- data/plugins/rigor-ethon/lib/rigor/plugin/ethon.rb +1 -0
- data/plugins/rigor-ffi/lib/rigor/plugin/ffi/types.rb +1 -1
- data/plugins/rigor-ffi/lib/rigor/plugin/ffi.rb +10 -0
- data/plugins/rigor-grape/lib/rigor/plugin/grape.rb +141 -0
- data/plugins/rigor-grape/lib/rigor-grape.rb +6 -0
- data/plugins/rigor-grape/sig/grape.rbs +263 -0
- data/plugins/rigor-graphql/lib/rigor/plugin/graphql.rb +72 -2
- data/plugins/rigor-graphql/sig/graphql.rbs +485 -0
- data/plugins/rigor-minitest/lib/rigor/plugin/minitest/assertion_analyzer.rb +2 -0
- data/plugins/rigor-pundit/lib/rigor/plugin/pundit.rb +11 -7
- data/plugins/rigor-rails-i18n/lib/rigor/plugin/rails_i18n.rb +35 -37
- data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/analyzer.rb +0 -1
- data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/devise_routes.rb +2 -0
- data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes/doorkeeper_routes.rb +1 -0
- data/plugins/rigor-rails-routes/lib/rigor/plugin/rails_routes.rb +9 -17
- data/plugins/rigor-rbs-inline/lib/rigor/plugin/rbs_inline/same_line_annotations.rb +149 -0
- data/plugins/rigor-rbs-inline/lib/rigor/plugin/rbs_inline.rb +217 -36
- data/plugins/rigor-sidekiq/lib/rigor/plugin/sidekiq/schedule_scan.rb +1 -0
- data/plugins/rigor-sidekiq/lib/rigor/plugin/sidekiq.rb +9 -5
- data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet/sigil_detector.rb +0 -1
- data/plugins/rigor-sorbet/lib/rigor/plugin/sorbet.rb +46 -1
- data/plugins/rigor-sorbet/sig/sorbet.rbs +277 -0
- data/sig/rigor/analysis/baseline.rbs +69 -7
- data/sig/rigor/analysis/fact_store.rbs +1 -1
- data/sig/rigor/analysis/project_scan.rbs +74 -0
- data/sig/rigor/effects/config_envelopes.rbs +100 -0
- data/sig/rigor/effects/effect_table.rbs +60 -0
- data/sig/rigor/effects/envelope.rbs +97 -0
- data/sig/rigor/effects/envelope_index.rbs +33 -0
- data/sig/rigor/effects/file_collection.rbs +81 -0
- data/sig/rigor/effects/label.rbs +26 -0
- data/sig/rigor/effects/label_set.rbs +46 -0
- data/sig/rigor/effects/method_key.rbs +24 -0
- data/sig/rigor/effects/origin.rbs +50 -0
- data/sig/rigor/effects/plugin_facts.rbs +141 -0
- data/sig/rigor/effects/registry.rbs +68 -0
- data/sig/rigor/effects/summary.rbs +50 -0
- data/sig/rigor/effects/taint_cause.rbs +12 -0
- data/sig/rigor/environment.rbs +14 -10
- data/sig/rigor/inference/optimistic_origin.rbs +10 -0
- data/sig/rigor/inference.rbs +6 -4
- data/sig/rigor/plugin/additional_initializer.rbs +36 -0
- data/sig/rigor/plugin/base.rbs +30 -7
- data/sig/rigor/plugin/effect_ancestry.rbs +27 -0
- data/sig/rigor/plugin/effect_attribution.rbs +66 -0
- data/sig/rigor/plugin/effect_edge.rbs +33 -0
- data/sig/rigor/plugin/effect_entry_points.rbs +25 -0
- data/sig/rigor/plugin/io_boundary.rbs +2 -1
- data/sig/rigor/plugin/loader.rbs +3 -3
- data/sig/rigor/plugin/manifest.rbs +50 -11
- data/sig/rigor/plugin/protocol_contract.rbs +68 -0
- data/sig/rigor/plugin/registry.rbs +62 -1
- data/sig/rigor/plugin.rbs +1 -1
- data/sig/rigor/rbs_extended.rbs +1 -1
- data/sig/rigor/reflection.rbs +7 -6
- data/sig/rigor/scope.rbs +177 -20
- data/sig/rigor/sig_gen/skip_reason_catalog.rbs +14 -7
- data/sig/rigor/source.rbs +4 -4
- data/sig/rigor/testing.rbs +10 -4
- data/sig/rigor/type.rbs +6 -0
- data/sig/rigor.rbs +38 -20
- data/skills/rigor-ask/SKILL.md +8 -5
- data/skills/rigor-baseline-reduce/SKILL.md +4 -6
- data/skills/rigor-ci-setup/SKILL.md +17 -21
- data/skills/rigor-doctor/SKILL.md +24 -22
- data/skills/rigor-doctor/references/01-checks.md +97 -33
- data/skills/rigor-editor-setup/SKILL.md +6 -4
- data/skills/rigor-mcp-setup/SKILL.md +5 -4
- data/skills/rigor-monkeypatch-resolve/SKILL.md +5 -3
- data/skills/rigor-next-steps/SKILL.md +4 -2
- data/skills/rigor-plugin-author/SKILL.md +19 -23
- data/skills/rigor-plugin-author/references/01-plan-and-scaffold.md +9 -8
- data/skills/rigor-plugin-author/references/02-walker-and-types.md +12 -25
- data/skills/rigor-plugin-author/references/03-test-and-ship.md +6 -8
- data/skills/rigor-plugin-review/SKILL.md +6 -4
- data/skills/rigor-plugin-review/references/01-best-practices-checklist.md +2 -1
- data/skills/rigor-plugin-tune/SKILL.md +4 -2
- data/skills/rigor-project-init/SKILL.md +46 -18
- data/skills/rigor-project-init/references/01-detect.md +13 -9
- data/skills/rigor-project-init/references/02-configure.md +40 -10
- data/skills/rigor-project-init/references/03-baseline-and-bugs.md +14 -14
- data/skills/rigor-project-init/references/04-sig-uplift.md +27 -14
- data/skills/rigor-protection-uplift/SKILL.md +4 -6
- data/skills/rigor-rbs-setup/SKILL.md +4 -2
- data/skills/rigor-type-oracle/SKILL.md +4 -6
- data/skills/rigor-type-oracle/references/01-oracle-commands.md +12 -8
- data/skills/rigor-type-oracle/references/03-gap-protocol.md +0 -3
- data/skills/rigor-unused-adjudicate/SKILL.md +4 -2
- data/skills/rigor-upgrade/SKILL.md +13 -8
- metadata +132 -1
|
@@ -36,7 +36,7 @@ ActionCable.server.broadcast("chat_room_42", body: "hi") # warning: no such s
|
|
|
36
36
|
| `plugin.actioncable.broadcast-stream` | info | `ActionCable.server.broadcast("...", ...)` matched a registered `stream_from` literal |
|
|
37
37
|
| `plugin.actioncable.unknown-channel` | error | the receiver ends in `Channel` but is not in the index (with a did-you-mean) |
|
|
38
38
|
| `plugin.actioncable.unknown-stream` | warning | the literal stream name matched no `stream_from` registration (with a did-you-mean) |
|
|
39
|
-
| `plugin.actioncable.load-error` | warning | channel discovery failed (parse/read error) — once per
|
|
39
|
+
| `plugin.actioncable.load-error` | warning | channel discovery failed (parse/read error) — once per run, on `.rigor.yml` |
|
|
40
40
|
|
|
41
41
|
The `unknown-stream` check is **suppressed** when any discovered
|
|
42
42
|
channel registers a dynamic stream (`stream_from interpolated_string`
|
|
@@ -100,6 +100,13 @@ default.
|
|
|
100
100
|
- **The `#receive` contract is path-scoped, not class-scoped** (ADR-28):
|
|
101
101
|
any `def receive(data)` defined anywhere under `channel_search_paths`
|
|
102
102
|
is typed, even on a class that isn't an ActionCable channel.
|
|
103
|
+
- **The "failed to discover channels" warning is run-scoped.** It is
|
|
104
|
+
a fact about your configuration, not about any one source file, so
|
|
105
|
+
it is reported once per run on `.rigor.yml` rather than repeated on
|
|
106
|
+
every analysed file. It is `:warning`, so if you baselined it at its
|
|
107
|
+
old position that entry no longer matches and the row fails a
|
|
108
|
+
`--fail-on=warning` run — regenerate with `rigor baseline
|
|
109
|
+
regenerate`.
|
|
103
110
|
|
|
104
111
|
## Plugin internals
|
|
105
112
|
|
|
@@ -69,6 +69,13 @@ plugins:
|
|
|
69
69
|
which the report already records. Rooting every class under
|
|
70
70
|
`app/mailers` instead would mark a mailer nothing sends reachable
|
|
71
71
|
forever on no evidence.
|
|
72
|
+
- **The "failed to discover mailers" warning is run-scoped.** It is
|
|
73
|
+
a fact about your configuration, not about any one source file, so
|
|
74
|
+
it is reported once per run on `.rigor.yml` rather than repeated on
|
|
75
|
+
every analysed file. It is `:warning`, so if you baselined it at its
|
|
76
|
+
old position that entry no longer matches and the row fails a
|
|
77
|
+
`--fail-on=warning` run — regenerate with `rigor baseline
|
|
78
|
+
regenerate`.
|
|
72
79
|
|
|
73
80
|
## Plugin internals
|
|
74
81
|
|
|
@@ -54,6 +54,7 @@ plugins:
|
|
|
54
54
|
config:
|
|
55
55
|
controller_search_paths: ["app/controllers"] # default
|
|
56
56
|
view_search_paths: ["app/views"] # default
|
|
57
|
+
view_type_checks: false # default
|
|
57
58
|
```
|
|
58
59
|
|
|
59
60
|
## What it types
|
|
@@ -111,8 +112,250 @@ reason `ActionController::Parameters` and the `ActionDispatch` readers
|
|
|
111
112
|
above stay undeclared; their leniency is what makes the `params`
|
|
112
113
|
typing safe.
|
|
113
114
|
|
|
115
|
+
## ERB templates as effect units
|
|
116
|
+
|
|
117
|
+
Every `app/views/**/*.erb` is compiled to Ruby and analysed as one
|
|
118
|
+
**effect unit**, keyed `view:users/show.html` — Rails' own logical
|
|
119
|
+
name with the handler dropped, so an ERB → Haml rewrite is not a
|
|
120
|
+
rename. Nothing has to be enabled: activating the plugin is what
|
|
121
|
+
claims the templates.
|
|
122
|
+
|
|
123
|
+
What that buys is the answer to *"what does this request actually
|
|
124
|
+
do"* past the `render` line. A partial that calls `@user.update`
|
|
125
|
+
reports `io.db.write` at `app/views/users/_card.html.erb`, a
|
|
126
|
+
`Time.now` in a layout fragment reports `nondet.time`, a leftover
|
|
127
|
+
`puts` reports `io.output.stdout` — all of it in `rigor effects` and
|
|
128
|
+
in the snapshot, so a template that starts writing shows up in a
|
|
129
|
+
diff.
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
$ rigor effects
|
|
133
|
+
view:users/_card.html: [mutate.local, nondet.time] ≤ [io.db.write] …?
|
|
134
|
+
view:users/show.html: [mutate.local] ≤ [io.db.read] …?
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
**The compiler** is Erubi when it resolves in your project's bundle
|
|
138
|
+
— Rails' own — and stdlib `ERB` otherwise. Erubi is never added to
|
|
139
|
+
your Gemfile and is not a Rigor dependency
|
|
140
|
+
([ADR-90](../../adr/90-target-library-resolution-from-project-bundle.md)).
|
|
141
|
+
Either way the line map is measured rather than assumed, so a
|
|
142
|
+
finding names the template's own line; the column is always 1,
|
|
143
|
+
because a compiler rewrites the text of each line and a column of
|
|
144
|
+
the compiled Ruby would name nothing you wrote.
|
|
145
|
+
|
|
146
|
+
**What `self` is.** `ActionView::Base`, declared so the name
|
|
147
|
+
resolves and **open** so its method surface stays lenient. That is
|
|
148
|
+
what keeps `link_to`, `form_with`, `t`, `content_for`, your own
|
|
149
|
+
`ApplicationHelper` methods and every route helper from drawing a
|
|
150
|
+
finding per line.
|
|
151
|
+
|
|
152
|
+
**What is in scope.** `@ivars` are seeded from the controller
|
|
153
|
+
actions that render the template — the implicit render
|
|
154
|
+
(`UsersController#show` → `users/show`) and explicit
|
|
155
|
+
`render :edit` / `render "admin/form"`. Two restrictions keep a seed
|
|
156
|
+
from claiming a type the template will not find. Only assignments
|
|
157
|
+
whose right-hand side is one record and cannot be `nil` contribute:
|
|
158
|
+
`User.find(id)` and `Model.new` do; `find_by` never does, nor a call
|
|
159
|
+
written to return several records — `User.find(a, b)`,
|
|
160
|
+
`User.find([1, 2])`, `User.find(*ids)`, `User.create([…])` or a
|
|
161
|
+
`find` with a block. A single argument that only holds an Array at
|
|
162
|
+
runtime (`User.find(ids)`) still seeds the model. And only
|
|
163
|
+
assignments the action reaches on **every** path contribute — not
|
|
164
|
+
one inside an `if`, a `case`, a `rescue`, a loop or a block, and
|
|
165
|
+
nothing from a `before_action` carrying `if:` / `unless:`. Anything
|
|
166
|
+
else leaves the ivar unseeded, which reads as `Dynamic` and is
|
|
167
|
+
silent. A partial inherits the assigns of its own directory, because
|
|
168
|
+
an ivar is not a local. Locals come from the Rails 7.1 strict-locals
|
|
169
|
+
comment:
|
|
170
|
+
|
|
171
|
+
```erb
|
|
172
|
+
<%# locals: (user:, admin: false) %>
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**`call.*` findings are off inside templates by default**, while the
|
|
176
|
+
synthesised receivers are still coarse — measured on redmine and
|
|
177
|
+
mastodon, the feature adds **zero** new findings to either
|
|
178
|
+
([the measurement note](../../notes/20260917-erb-template-units.md)).
|
|
179
|
+
Set `view_type_checks: true` to opt in and have `@user.nmae` in
|
|
180
|
+
`show.html.erb` reported like any other call.
|
|
181
|
+
|
|
182
|
+
`flow.*` **reports in a template like anywhere else.** It was
|
|
183
|
+
suppressed alongside `call.*` for one measured reason — a partial's
|
|
184
|
+
optional-local preamble (`<% path = nil unless defined? path %>`)
|
|
185
|
+
really did assign nil, because nothing told the unit its render site
|
|
186
|
+
had bound `path`. Render-site `locals:` are traced now, and the same
|
|
187
|
+
two projects re-measured with the family reporting are byte-identical
|
|
188
|
+
to the runs with it suppressed ([the #1047 note](../../notes/20260917-render-locals-and-layouts.md)).
|
|
189
|
+
|
|
190
|
+
### Locals come from the render site
|
|
191
|
+
|
|
192
|
+
A partial's parameters are bound by whoever renders it, and every
|
|
193
|
+
spelling of that is read — on both sides of the render:
|
|
194
|
+
|
|
195
|
+
```erb
|
|
196
|
+
<%= render partial: "card", locals: { user: @user } %>
|
|
197
|
+
<%= render "card", user: @user %> <%# a view's trailing hash IS locals %>
|
|
198
|
+
<%= render partial: "card", collection: @users, as: :row %>
|
|
199
|
+
<%= render partial: "card", object: @user %>
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
`collection:` binds `row`, `row_counter` and `row_iteration`;
|
|
203
|
+
`object:` and `as:` bind one local named after the partial or after
|
|
204
|
+
`as:`. A controller's `render partial: …, locals: …` is read the same
|
|
205
|
+
way — but a controller's *trailing hash* is options, so
|
|
206
|
+
`render :show, status: :ok` binds nothing.
|
|
207
|
+
|
|
208
|
+
A partial rendered from several sites gets the **union** of the
|
|
209
|
+
names. A name only some of them pass is still bound, typed
|
|
210
|
+
`Dynamic` — absence is what produced the false positives above.
|
|
211
|
+
A **type** is claimed only where every site agrees on one it could
|
|
212
|
+
settle from the call itself (`User.find(1)`, or an ivar the rendering
|
|
213
|
+
action's own seeds typed); anything else is `Dynamic`. A
|
|
214
|
+
strict-locals comment still wins where a template carries one.
|
|
215
|
+
|
|
216
|
+
A partial's **own** optional-local test counts too:
|
|
217
|
+
`<% size = nil unless defined?(size) %>`, `local_assigns[:size]` and
|
|
218
|
+
`local_assigns.key?(:size)` bind `size` even when no render site the
|
|
219
|
+
plugin can read passes it — a `locals: opts` hash, a `render` from a
|
|
220
|
+
helper, or a local with a default nobody passes. A name a helper under
|
|
221
|
+
`app/helpers` defines is left alone, so
|
|
222
|
+
`<% if defined?(current_user) %>` stays a helper call. A helper that a
|
|
223
|
+
gem or a concern defines is not seen by that scan, and its name is
|
|
224
|
+
bound as a `Dynamic` local instead.
|
|
225
|
+
|
|
226
|
+
### The controller → template edge
|
|
227
|
+
|
|
228
|
+
A controller action's summary **includes what its template does**.
|
|
229
|
+
`render :show`, `render "show"`, `render "admin/form"`,
|
|
230
|
+
`render template:`, `render action:`, `render partial:` (with or
|
|
231
|
+
without `collection:`) and the implicit render of
|
|
232
|
+
`<controller>/<action>` all reach the template's own unit, and a
|
|
233
|
+
template reaches the partials *it* renders — so an `io.db.write` in
|
|
234
|
+
`app/views/users/_card.html.erb` shows up on `UsersController#show`
|
|
235
|
+
three hops away, and `rigor effects explain` prints the path.
|
|
236
|
+
|
|
237
|
+
A partial is looked up in the rendering template's own format, with
|
|
238
|
+
the one fallback Action View itself hard-codes: a `.js.erb` template
|
|
239
|
+
reaches `_list.js.erb` where it exists and `_list.html.erb`
|
|
240
|
+
otherwise, which is how "a JS response that injects rendered HTML"
|
|
241
|
+
works at all. Only one of the two is joined, never both. A `.json`,
|
|
242
|
+
`.xml` or `.turbo_stream` template gets no fallback — what those fall
|
|
243
|
+
back to depends on the request's `Accept` header, which the source
|
|
244
|
+
does not say — and neither does a render site that names its format
|
|
245
|
+
(`formats: [:js]`, `render "list.js"`) or a controller-side `render`.
|
|
246
|
+
|
|
247
|
+
The fallback stops at a template that **exists and produced no
|
|
248
|
+
unit**: a `_list.js.haml`, or a `_list.js.erb` whose compiled Ruby
|
|
249
|
+
does not parse. Rails runs that file, so the `.html` one's effects
|
|
250
|
+
are not what the render produces, and the taint stays. That is why
|
|
251
|
+
this plugin claims `app/views/**/*.{haml,slim,jbuilder,builder,rabl,ruby}`
|
|
252
|
+
and compiles none of them: the claim is how the engine learns a
|
|
253
|
+
template is there. A handler outside that list is invisible, and a
|
|
254
|
+
render of one still falls back.
|
|
255
|
+
|
|
256
|
+
Two approximations ride along, and each costs labels rather than a
|
|
257
|
+
taint. A partial reached *through* the fallback renders its own
|
|
258
|
+
partials in `html`, while Action View's context is still
|
|
259
|
+
`[:js, :html]`; where a nested partial exists in both formats, the
|
|
260
|
+
`.js` template gets the `.html` one's labels. And a template whose
|
|
261
|
+
name carries no format at all (`_row.jbuilder`) blocks nothing, since
|
|
262
|
+
its key has no format to block — which happens to agree with Rails,
|
|
263
|
+
which ranks a formatted template above it. Both are zero occurrences
|
|
264
|
+
on the measured corpus.
|
|
265
|
+
|
|
266
|
+
The `template-not-analysed` taint on a `render` is discharged
|
|
267
|
+
exactly when the edge lands on a real unit. It **stays** when it
|
|
268
|
+
does not, and both cases are common enough to name:
|
|
269
|
+
|
|
270
|
+
- the target is computed — `render params[:view]`, or
|
|
271
|
+
`render formats: some_format`. The render site is read from
|
|
272
|
+
literals only, so anything computed keeps the honest "and possibly
|
|
273
|
+
more";
|
|
274
|
+
- the target names no template this plugin compiled — a `render
|
|
275
|
+
partial: @thing`, or a partial that exists in neither the requested
|
|
276
|
+
format nor its fallback;
|
|
277
|
+
- the template is outside `app/views/**/*.erb` — a Haml, Slim or
|
|
278
|
+
Jbuilder view, which this plugin does not claim.
|
|
279
|
+
|
|
280
|
+
`render json:`, `render plain:` and the rest of the non-template
|
|
281
|
+
family are left alone: they render no template, the rule declines,
|
|
282
|
+
and the row reads exactly as it did before.
|
|
283
|
+
|
|
284
|
+
An action that answered for itself is **not** edged to the
|
|
285
|
+
conventional template. `redirect_to`, `head`, `send_data` and
|
|
286
|
+
`send_file` each mean the implicit render did not happen, and
|
|
287
|
+
attributing `users/away` to an action that redirects would be a view
|
|
288
|
+
it never runs.
|
|
289
|
+
|
|
290
|
+
### Holding views to an effect budget
|
|
291
|
+
|
|
292
|
+
A view unit is an `effects.envelopes:` subject like any class, and a
|
|
293
|
+
finding is positioned in the template:
|
|
294
|
+
|
|
295
|
+
```yaml
|
|
296
|
+
effects:
|
|
297
|
+
envelopes:
|
|
298
|
+
- match: "app/views/**/*"
|
|
299
|
+
effect: [mutate.local]
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
A bound judges only what Rigor proved by reading code, so what this
|
|
303
|
+
catches in a view is what Rigor's own catalogue proves: a `puts`
|
|
304
|
+
(`io.output.stdout`) or a `Time.now` (`nondet.time`).
|
|
305
|
+
|
|
306
|
+
**Plugin-sourced labels are never judged by an envelope.** A plugin's
|
|
307
|
+
statement about a framework method — `User.find` is `io.db.read`,
|
|
308
|
+
`@user.update` is `io.db.write`, `perform_later` is `job.enqueue` —
|
|
309
|
+
rides the declared (`≤`) lane, and the envelope check reads the proven
|
|
310
|
+
one. Listing `io.db.read` in a view's envelope, or leaving it out,
|
|
311
|
+
changes nothing: the lazy `<%= user.posts.count %>` is not a finding
|
|
312
|
+
either way. That is a property of the whole Rails effect layer rather
|
|
313
|
+
than of views ([ADR-103](../../adr/103-effect-labels.md) WD17, ruled
|
|
314
|
+
in [#1059](https://github.com/rigortype/rigor/issues/1059)).
|
|
315
|
+
|
|
316
|
+
What notices a view that starts reading the database is the effect
|
|
317
|
+
snapshot. With `.rigor-effects.yml` committed, `rigor effects check`
|
|
318
|
+
fails by default on drift in either lane, and a template that gains a
|
|
319
|
+
query shows up in the diff as a declared-lane addition:
|
|
320
|
+
|
|
321
|
+
```
|
|
322
|
+
view:users/show.html ≤+ io.db.read
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
That is a ratchet on the whole project's recorded effects, reviewed as a
|
|
326
|
+
diff — not a policy scoped to `app/views/**/*`. See
|
|
327
|
+
[Effect labels](../19-effect-labels.md#what-a-bound-can-and-cannot-see).
|
|
328
|
+
|
|
114
329
|
## Limitations
|
|
115
330
|
|
|
331
|
+
- **A controller's own layout is not edged.** A layout is a unit
|
|
332
|
+
now, and a `render layout:` *inside a view* reaches it — but the
|
|
333
|
+
layout Rails wraps an action's template in (`layouts/application`,
|
|
334
|
+
or whatever `layout "base"` named) is not attributed to that
|
|
335
|
+
action. A callee rule may read the call's literals, the unit's
|
|
336
|
+
owner and the unit's key, and a layout's name is none of those:
|
|
337
|
+
it is a class-body declaration plus a convention lookup against
|
|
338
|
+
the view tree. So the layout's own effects reach a view that
|
|
339
|
+
renders it explicitly and no further.
|
|
340
|
+
- **`yield` in a layout is a `String` and nothing more.** The
|
|
341
|
+
keyword is rewritten into a declared call on the view context so
|
|
342
|
+
the body parses; what the inner template produced is never
|
|
343
|
+
modelled.
|
|
344
|
+
- **Unsaved render sites are not read in the editor.** The
|
|
345
|
+
render-site index reads templates and controllers from disk, so a
|
|
346
|
+
`locals:` you have typed but not saved does not reach the partial
|
|
347
|
+
until the save. A keystroke recompiles only the buffer, and a save
|
|
348
|
+
rebuilds the project's analysis as it always has. A view changed on
|
|
349
|
+
disk *without* a save the editor sees (a `git checkout`, a
|
|
350
|
+
formatter run elsewhere) recompiles every view on the next
|
|
351
|
+
publish, because a partial's locals can come from any of them. A
|
|
352
|
+
full `rigor check` does
|
|
353
|
+
the same compile work it did before — the index hands its compiled
|
|
354
|
+
sources to the unit transform rather than compiling twice.
|
|
355
|
+
- **ERB only, under `app/views`.** `template_globs:` is a manifest
|
|
356
|
+
row, read without running plugin code, so it cannot consult
|
|
357
|
+
`view_search_paths:`. Haml, Slim and Jbuilder are the same seam
|
|
358
|
+
behind a different compiler and are not claimed.
|
|
116
359
|
- **Implicit-self helpers only.** `*_path` / `*_url` calls with an
|
|
117
360
|
explicit receiver (`Rails.application.routes.url_helpers.x_path`)
|
|
118
361
|
are passed through.
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# rigor-active-model-serializers
|
|
2
|
+
|
|
3
|
+
Teaches Rigor what `object` is inside an ActiveModel::Serializer
|
|
4
|
+
subclass, so the reads below it — `object.username`,
|
|
5
|
+
`object.account.display_name` — resolve against your model instead of
|
|
6
|
+
dispatching on an unknown receiver. It reads source only; no
|
|
7
|
+
ActiveModelSerializers runtime dependency.
|
|
8
|
+
|
|
9
|
+
It ships bundled in `rigortype`. Activate it under `plugins:`, alongside
|
|
10
|
+
`rigor-activerecord`, which is what tells this plugin which models exist
|
|
11
|
+
and what they answer:
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
plugins:
|
|
15
|
+
- rigor-activerecord
|
|
16
|
+
- rigor-active-model-serializers
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## What it does — no diagnostics
|
|
20
|
+
|
|
21
|
+
The plugin emits nothing of its own. It contributes one return type and
|
|
22
|
+
the gem's framework constants, so that
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
class REST::AccountSerializer < ActiveModel::Serializer
|
|
26
|
+
attributes :id, :username, :display_name
|
|
27
|
+
|
|
28
|
+
def display_name
|
|
29
|
+
object.display_name
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
types `object` as `Account`, and `object.display_name` as the
|
|
35
|
+
`accounts.display_name` column's type. What you notice is the diagnostics
|
|
36
|
+
that now CAN fire — a typo below a serializer's `object` used to be
|
|
37
|
+
invisible:
|
|
38
|
+
|
|
39
|
+
```text
|
|
40
|
+
app/serializers/errors_serializer.rb:11:23: error: undefined method `nickname' for String [call.undefined-method]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
and `rigor coverage` reporting a larger share of `app/serializers` as
|
|
44
|
+
precise. On Mastodon that share went from 51.1 % to 53.2 % with no change
|
|
45
|
+
at all to the diagnostic set
|
|
46
|
+
([the measurement](../../notes/20260917-ams-object-recognizer.md)).
|
|
47
|
+
|
|
48
|
+
## When `object` is typed, and when it is not
|
|
49
|
+
|
|
50
|
+
Nothing in a serializer's source states which class it serializes — AMS
|
|
51
|
+
binds the resource when the serializer is constructed. So the type is
|
|
52
|
+
always DERIVED, and two independent things have to agree before the
|
|
53
|
+
plugin contributes one:
|
|
54
|
+
|
|
55
|
+
1. **The name resolves.** `<Model>Serializer` names exactly one model
|
|
56
|
+
your project has — `REST::AccountSerializer` → `Account`.
|
|
57
|
+
2. **The model answers the serializer.** Every name the serializer will
|
|
58
|
+
read off its resource — the `attributes` / `attribute` / `has_many` /
|
|
59
|
+
`has_one` / `belongs_to` declarations it does not define itself, plus
|
|
60
|
+
every `object.<name>` in its body — is a column, per-column predicate,
|
|
61
|
+
association, enum, alias, scope or macro-defined method of that model,
|
|
62
|
+
or a method your project defines on it or an ancestor.
|
|
63
|
+
|
|
64
|
+
One unanswered name declines the whole serializer, because the resource
|
|
65
|
+
is then something else — commonly a presenter or a decorator around the
|
|
66
|
+
model, which shares most of its surface and is given away by the one or
|
|
67
|
+
two names that differ. On Mastodon that check is what stops
|
|
68
|
+
`REST::ConversationSerializer` typing as `Conversation` when its resource
|
|
69
|
+
is an `AccountConversation`.
|
|
70
|
+
|
|
71
|
+
| your code | `object` types as |
|
|
72
|
+
| --- | --- |
|
|
73
|
+
| `REST::AccountSerializer`, `Account` exists and answers it | `Account` |
|
|
74
|
+
| `Admin::AccountSerializer`, where `Admin::Account` and `Account` both exist | unchanged — the reading is ambiguous and nothing here ranks one above the other |
|
|
75
|
+
| `ConversationSerializer` whose declarations `Conversation` cannot answer | unchanged (`Dynamic`) |
|
|
76
|
+
| a serializer that reads nothing off its resource | unchanged — there is nothing to check the name against |
|
|
77
|
+
| `ContextSerializer`, and no `Context` **model** exists | unchanged (`Dynamic`) |
|
|
78
|
+
| a serializer you listed in `model_overrides` | the model you named |
|
|
79
|
+
| `object` written outside a serializer, or over your own `def object` | unchanged (`Dynamic`) |
|
|
80
|
+
|
|
81
|
+
A serializer is a class under `serializer_search_paths` whose superclass
|
|
82
|
+
chain reaches `ActiveModel::Serializer` — including through your own base
|
|
83
|
+
serializer (`class ApplicationSerializer < ActiveModel::Serializer`, then
|
|
84
|
+
`class AccountSerializer < ApplicationSerializer`). A class the chain does
|
|
85
|
+
not reach is not a serializer here whatever it is called: `object` is an
|
|
86
|
+
ordinary method name, and a `Json::ConversationSerializer` of your own is
|
|
87
|
+
entitled to define it.
|
|
88
|
+
|
|
89
|
+
`class << self` and `def self.` bodies are left alone. An `object` read
|
|
90
|
+
there is a `NoMethodError` at run time — AMS's reader is an instance
|
|
91
|
+
method — so there is nothing to type and nothing the plugin should say
|
|
92
|
+
about it.
|
|
93
|
+
|
|
94
|
+
**The plugin never guesses.** Where the resource cannot be established it
|
|
95
|
+
contributes nothing and `object` keeps the answer it had, because a wrong
|
|
96
|
+
class here would turn every read on it into a false
|
|
97
|
+
`call.undefined-method` on working code.
|
|
98
|
+
|
|
99
|
+
It also does nothing at all without `rigor-activerecord`, or on a project
|
|
100
|
+
with no `db/schema.rb` / `db/structure.sql`: the model set it resolves and
|
|
101
|
+
checks against comes from that plugin, and is withheld when the schema is
|
|
102
|
+
missing.
|
|
103
|
+
|
|
104
|
+
## Configuration
|
|
105
|
+
|
|
106
|
+
```yaml
|
|
107
|
+
plugins:
|
|
108
|
+
- gem: rigor-active-model-serializers
|
|
109
|
+
config:
|
|
110
|
+
serializer_search_paths: ["app/serializers", "app/lib"]
|
|
111
|
+
serializer_base_classes: ["ActiveModel::Serializer"]
|
|
112
|
+
model_overrides:
|
|
113
|
+
REST::InstanceSerializer: InstancePresenter
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
| Key | Default | Meaning |
|
|
117
|
+
| --- | --- | --- |
|
|
118
|
+
| `serializer_search_paths` | `["app/serializers", "app/lib"]` | Where to look for serializer classes. `app/lib` is in the default set because a base serializer routinely lives outside `app/serializers` — Mastodon's `ActivityPub::Serializer`, the parent of 60 of its serializers, is one. A directory you do not have costs one probe. |
|
|
119
|
+
| `serializer_base_classes` | `["ActiveModel::Serializer"]` | The roots the ancestry walk starts from. |
|
|
120
|
+
| `model_overrides` | `{}` | Serializer class name → resource class name, for a serializer the derivation cannot reach — a presenter, a decorator, or a class named for a JSON shape. Your assertion; it is not re-checked. |
|
|
121
|
+
|
|
122
|
+
## Limitations
|
|
123
|
+
|
|
124
|
+
- **SimpleForm inputs.** `SimpleForm::Inputs::Base#object` shares the name
|
|
125
|
+
and nothing else — its resource comes from the `simple_form_for` call
|
|
126
|
+
site, not from the input class.
|
|
127
|
+
- **`serializer:` / `each_serializer:` options.** They name the
|
|
128
|
+
serializer for an association, never the model for a serializer.
|
|
129
|
+
- **Model surface your schema and source do not state.** A method the
|
|
130
|
+
model gets from `method_missing`, from a gem's macro `rigor-activerecord`
|
|
131
|
+
does not recognise, or from a module included at runtime is invisible to
|
|
132
|
+
the model index, so a serializer reading one is declined.
|
|
133
|
+
`rigor-activerecord` reads `delegate`, the associations a concern
|
|
134
|
+
declares in its `included do`, the Paperclip / Active Storage attachment
|
|
135
|
+
macros and `enum` value predicates
|
|
136
|
+
([#1049](https://github.com/rigortype/rigor/issues/1049)); anything else
|
|
137
|
+
a macro defines is not folded yet.
|
|
138
|
+
- **Some ways of reading the resource.** `object[:key]`, `object.title =`,
|
|
139
|
+
`object.try(:name)`, `object.present?` and an `attribute(:x) { ... }`
|
|
140
|
+
block are not read as evidence, so a serializer using one may decline
|
|
141
|
+
even where the model is right. Always the safe direction — a decline,
|
|
142
|
+
never a wrong type.
|
|
143
|
+
- **Serializers for plain objects** — `ActiveModelSerializers::Model`
|
|
144
|
+
subclasses, Structs, presenters. Use `model_overrides` where the class
|
|
145
|
+
you want is a real constant you are happy to have checked.
|
|
146
|
+
|
|
147
|
+
## Plugin internals
|
|
148
|
+
|
|
149
|
+
The serializer discoverer / index, the ancestry closure and the contract
|
|
150
|
+
surfaces this plugin exercises are in the
|
|
151
|
+
[plugin's README](../../../plugins/rigor-active-model-serializers/README.md).
|
|
152
|
+
To write a plugin, see [`examples/`](../../../examples/README.md) and the
|
|
153
|
+
[`rigor-plugin-author`](../08-skills.md) skill.
|
|
@@ -95,6 +95,13 @@ nothing loads Solid Queue.
|
|
|
95
95
|
evidence. A schedule loaded from Ruby rather than from a file under
|
|
96
96
|
`recurring_paths` supplies nothing, by the same "read only what is
|
|
97
97
|
written" rule.
|
|
98
|
+
- **The "failed to discover jobs" warning is run-scoped.** It is
|
|
99
|
+
a fact about your configuration, not about any one source file, so
|
|
100
|
+
it is reported once per run on `.rigor.yml` rather than repeated on
|
|
101
|
+
every analysed file. It is `:warning`, so if you baselined it at its
|
|
102
|
+
old position that entry no longer matches and the row fails a
|
|
103
|
+
`--fail-on=warning` run — regenerate with `rigor baseline
|
|
104
|
+
regenerate`.
|
|
98
105
|
|
|
99
106
|
## Plugin internals
|
|
100
107
|
|
|
@@ -29,13 +29,21 @@ errors_demo.rb:24:1: error: `User.find` expects at least 1 argument, got 0 [plug
|
|
|
29
29
|
| --- | --- | --- |
|
|
30
30
|
| Recognised `Model.find` / `Model.find_by` / `Model.where` call | `:info` | `plugin.activerecord.model-call` |
|
|
31
31
|
| `Model.find_by(unknown: ...)` / `Model.where(unknown: ...)` | `:error` | `plugin.activerecord.unknown-column` |
|
|
32
|
-
| `Model.find` with 0 args | `:error` | `plugin.activerecord.wrong-arity` |
|
|
32
|
+
| `Model.find` with 0 args and no block (unless the model defines `self.find`) | `:error` | `plugin.activerecord.wrong-arity` |
|
|
33
33
|
| No schema source (`db/schema.rb` or `db/structure.sql`) present — reduced mode | `:info` | `plugin.activerecord.load-error` |
|
|
34
34
|
| A schema source that exists but cannot be read or parsed | `:warning` | `plugin.activerecord.load-error` |
|
|
35
35
|
|
|
36
36
|
Did-you-mean suggestions use `DidYouMean` fuzzy matching against
|
|
37
37
|
the resolved table's column names.
|
|
38
38
|
|
|
39
|
+
A model that defines its own `self.find` owns that method's arity.
|
|
40
|
+
The plugin reports no `wrong-arity` for it, and no note for the
|
|
41
|
+
several-id or block form, where the call types as the model's
|
|
42
|
+
method rather than Rails' `find`. A single id is still noted as the
|
|
43
|
+
model, which is how it types. In an editor, a `self.find` in the
|
|
44
|
+
same file is not yet seen here, so the note and the error still
|
|
45
|
+
appear there ([#1329](https://github.com/rigortype/rigor/issues/1329)).
|
|
46
|
+
|
|
39
47
|
## Configuration
|
|
40
48
|
|
|
41
49
|
```yaml
|
|
@@ -61,8 +69,17 @@ All keys are optional. Tweak them when:
|
|
|
61
69
|
## What it infers
|
|
62
70
|
|
|
63
71
|
The plugin contributes call-site types as well as diagnostics.
|
|
64
|
-
Class-side: `User.find(1)` → `User`, `User.
|
|
65
|
-
`User
|
|
72
|
+
Class-side: `User.find(1)` → `User`, `User.find(1, 2)` →
|
|
73
|
+
`Array[User]`, `User.find_by(...)` → `User | nil`,
|
|
74
|
+
`User.find_by!(...)` → non-nullable `User`. A single argument
|
|
75
|
+
stays `User` even when it is an Array (`User.find([1, 2])`), so
|
|
76
|
+
that an untyped one, such as `params[:id]`, keeps the model type.
|
|
77
|
+
A relation or association (`user.posts.find(1, 2)`) answers the
|
|
78
|
+
same way. With a block, `find` is `Enumerable#find` over the
|
|
79
|
+
records, on the class and on a relation alike:
|
|
80
|
+
`User.find { |u| u.admin? }` → `User | nil`, and it takes no id.
|
|
81
|
+
The block's parameter is the model on a relation; on the class
|
|
82
|
+
side it stays untyped.
|
|
66
83
|
Instance-side: a column read (`user.name`) narrows to the
|
|
67
84
|
column's value type, `user.admin?` to `bool`, and a singular
|
|
68
85
|
association (`post.user`) to the target model.
|
|
@@ -76,6 +93,71 @@ Chained query methods keep the element type, and iteration
|
|
|
76
93
|
scope invoked on a typed relation (`User.where(...).published`)
|
|
77
94
|
never surfaces a false `call.undefined-method`.
|
|
78
95
|
|
|
96
|
+
A `scope` declared inside a concern's `included do ... end` block
|
|
97
|
+
counts as the including model's own. `Account.without_suspended`
|
|
98
|
+
types as `ActiveRecord::Relation[Account]` when `Account` includes
|
|
99
|
+
the concern that declares the scope — directly, or through another
|
|
100
|
+
concern that concern includes. A concern included once in your
|
|
101
|
+
base class (`ApplicationRecord`) reaches every model under it.
|
|
102
|
+
Attribution follows the `include` you wrote, not the name: a
|
|
103
|
+
model that includes nothing gets nothing, whatever some other
|
|
104
|
+
concern in the project declares.
|
|
105
|
+
|
|
106
|
+
The gate is the `included do ... end` block itself. A scope
|
|
107
|
+
declared some other way — in a `class_methods do` block, a
|
|
108
|
+
hand-written `def self.included(base)` with `base.class_eval`, or
|
|
109
|
+
directly in the body of your base class rather than in a concern —
|
|
110
|
+
is not folded, and the call stays as untyped as it was.
|
|
111
|
+
|
|
112
|
+
`belongs_to` / `has_one` / `has_many` /
|
|
113
|
+
`has_and_belongs_to_many` declared in that same `included do ...
|
|
114
|
+
end` block count as the including model's own too, with the same
|
|
115
|
+
`include`-edge attribution: `account.user` narrows to
|
|
116
|
+
`User | nil` when `Account` includes the concern that declares
|
|
117
|
+
`has_one :user`, and `where(user: ...)` stops reporting a false
|
|
118
|
+
`unknown-column`. A model that declares the association itself
|
|
119
|
+
keeps its own version.
|
|
120
|
+
|
|
121
|
+
### The names a macro defines
|
|
122
|
+
|
|
123
|
+
Three macro families define ordinary instance methods that are
|
|
124
|
+
neither columns nor associations, and the model's recorded
|
|
125
|
+
surface now carries their names:
|
|
126
|
+
|
|
127
|
+
- `delegate :followers_count, to: :account_stat` — every
|
|
128
|
+
delegated name, including the `prefix:` spellings
|
|
129
|
+
(`delegate :can?, to: :user, prefix: true` defines
|
|
130
|
+
`user_can?`). `delegate` is read from the model body, from a
|
|
131
|
+
concern's `included do ... end`, and from a concern's own
|
|
132
|
+
top level, where it defines an instance method the including
|
|
133
|
+
model inherits.
|
|
134
|
+
- Attachment macros — Paperclip's `has_attached_file :avatar`
|
|
135
|
+
(`avatar`, `avatar=`, `avatar?`) and Active Storage's
|
|
136
|
+
`has_one_attached` / `has_many_attached` (`banner`,
|
|
137
|
+
`banner_attachment`, `banner_blob`; `docs`,
|
|
138
|
+
`docs_attachments`, `docs_blobs`). Paperclip's
|
|
139
|
+
`avatar_file_name` / `avatar_content_type` / `avatar_file_size`
|
|
140
|
+
/ `avatar_updated_at` are real columns, so they come from your
|
|
141
|
+
schema rather than from the macro.
|
|
142
|
+
- `enum` value predicates — `enum :visibility, { limited: 4 },
|
|
143
|
+
suffix: :visibility` defines `limited_visibility?`, and
|
|
144
|
+
`prefix:` / `_prefix:` / `_suffix:` are read the same way. An
|
|
145
|
+
`enum` declared `instance_methods: false` defines none of
|
|
146
|
+
them, and none are recorded.
|
|
147
|
+
|
|
148
|
+
These are recorded as NAMES. Nothing here says what a delegated
|
|
149
|
+
method returns, and the plugin contributes no type for one — the
|
|
150
|
+
value is that a consumer asking "does this model answer
|
|
151
|
+
`followers_count`?" gets the right answer. The consumer this was
|
|
152
|
+
built for is
|
|
153
|
+
[`rigor-active-model-serializers`](rigor-active-model-serializers.md),
|
|
154
|
+
which types a serializer's `object` only when the candidate model
|
|
155
|
+
answers every name the serializer reads.
|
|
156
|
+
|
|
157
|
+
A declaration this plugin cannot read off the source contributes
|
|
158
|
+
nothing rather than a guess: a `prefix: true` whose `to:` is a
|
|
159
|
+
method call, a non-literal `prefix:`, a computed enum value list.
|
|
160
|
+
|
|
79
161
|
If the project also installs `activerecord` through
|
|
80
162
|
`rbs collection install`, the collection declares
|
|
81
163
|
`ActiveRecord::Relation` without a type parameter while the
|
|
@@ -182,12 +264,25 @@ close every model in the project.
|
|
|
182
264
|
the column-dependent half stands down — column readers stay
|
|
183
265
|
untyped and `where(col:)` keys are not validated, exactly as they
|
|
184
266
|
are for a table the schema does not describe. The plugin says so
|
|
185
|
-
once per run at `:info
|
|
267
|
+
once per run at `:info`, positioned on `.rigor.yml` — it is a
|
|
268
|
+
fact about your configuration, not about any one source file,
|
|
269
|
+
and you get the same single row with `--workers` as without. If
|
|
270
|
+
you baselined this row at its old position (a controller or a
|
|
271
|
+
model), that baseline entry no longer matches it — run `rigor
|
|
272
|
+
baseline regenerate`. Committing a schema dump (or pointing
|
|
186
273
|
`schema_file` / `structure_sql_file` at one) turns the column half
|
|
187
274
|
back on from the next cold run — a warm cache keeps serving the
|
|
188
275
|
reduced index until it is invalidated, so use `rigor check
|
|
189
276
|
--no-cache` (or `make cache-clean`) if you want to see the change
|
|
190
277
|
immediately.
|
|
278
|
+
- **Every kind of relation shares one signature.**
|
|
279
|
+
`user.posts`, `user.posts.where(...)` and `Post.where(...)` all
|
|
280
|
+
type as `ActiveRecord::Relation[Post]`, although only the first
|
|
281
|
+
is an association's `CollectionProxy`, so the signature they share
|
|
282
|
+
accepts the widest argument list any of them takes.
|
|
283
|
+
`user.posts.delete_all(:nullify)` is valid and not reported. The
|
|
284
|
+
same call on the other two raises `ArgumentError` at run time, and
|
|
285
|
+
is not reported either.
|
|
191
286
|
- **Column reads, not setters.** The plugin types instance-side
|
|
192
287
|
column *reads* (`user.name`, `user.admin?`) and singular
|
|
193
288
|
associations, but not the `name=` setter or the dirty-tracking
|
|
@@ -201,6 +296,17 @@ close every model in the project.
|
|
|
201
296
|
|
|
202
297
|
## Plugin internals
|
|
203
298
|
|
|
299
|
+
The plugin also answers `Plugin::Base#declared_members` (ADR-113
|
|
300
|
+
WD4): it enumerates each model's synthesized members — column
|
|
301
|
+
readers and `column?` predicates, association accessors, declared
|
|
302
|
+
scopes, enum attributes, and macro-defined names — off the prepared
|
|
303
|
+
model index, so `rigor lens` can list `User`'s members without a
|
|
304
|
+
grep-able declaration. A row carries the member-level type the
|
|
305
|
+
plugin commits to: `Dynamic[top]` for column readers on purpose
|
|
306
|
+
(the bare, receiver-less read's answer — a written `user.name`
|
|
307
|
+
still narrows to the column's type), and a type only where the
|
|
308
|
+
plugin already answers one at `check`.
|
|
309
|
+
|
|
204
310
|
Architecture (the cached schema-parser → model-index → analyzer
|
|
205
311
|
chain), the source layout, how to run the demo, and the plugin
|
|
206
312
|
contract surfaces this plugin exercises are documented in the
|
|
@@ -40,12 +40,19 @@ arguments decline — those are covered by ActiveStorage's own RBS.
|
|
|
40
40
|
| Rule | Severity | When |
|
|
41
41
|
| --- | --- | --- |
|
|
42
42
|
| `plugin.activestorage.attachment-call` | info | a recognised `model.attachment_name` call surfaces; confirms the model → attachment mapping |
|
|
43
|
-
| `plugin.activestorage.load-error` | warning | discovery failed (e.g. the model directory is inaccessible under the IoBoundary trust policy) |
|
|
43
|
+
| `plugin.activestorage.load-error` | warning | discovery failed (e.g. the model directory is inaccessible under the IoBoundary trust policy) — once per run, on `.rigor.yml` |
|
|
44
44
|
|
|
45
45
|
No `:error` diagnostics in this slice — the value is the
|
|
46
46
|
return-type contribution; an "unknown attachment name" rule is a
|
|
47
47
|
future slice.
|
|
48
48
|
|
|
49
|
+
The `load-error` warning is run-scoped: it is a fact about your
|
|
50
|
+
configuration, not about any one source file, so it is reported once
|
|
51
|
+
per run on `.rigor.yml` rather than repeated on every analysed file.
|
|
52
|
+
It is `:warning`, so if you baselined it at its old position that
|
|
53
|
+
entry no longer matches and the row fails a `--fail-on=warning` run —
|
|
54
|
+
regenerate with `rigor baseline regenerate`.
|
|
55
|
+
|
|
49
56
|
## Configuration
|
|
50
57
|
|
|
51
58
|
```yaml
|