rigortype 0.3.9 → 0.4.0
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 +2 -2
- 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/10-sorbet.md +9 -10
- data/docs/handbook/11-sig-gen.md +454 -13
- data/docs/manual/02-cli-reference.md +63 -2
- data/docs/manual/03-configuration.md +7 -0
- data/docs/manual/04-diagnostics.md +4 -0
- data/docs/manual/07-plugins.md +1 -1
- data/docs/manual/10-mcp-server.md +3 -2
- 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 +323 -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 +520 -49
- data/lib/rigor/analysis/dependency_recorder.rb +23 -0
- data/lib/rigor/analysis/fact_store.rb +9 -0
- data/lib/rigor/analysis/incremental.rb +26 -0
- data/lib/rigor/analysis/incremental_session.rb +36 -4
- 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 +1 -0
- data/lib/rigor/analysis/rule_catalog.rb +127 -0
- data/lib/rigor/analysis/run_cache_key.rb +20 -11
- data/lib/rigor/analysis/runner/diagnostic_aggregator.rb +167 -11
- data/lib/rigor/analysis/runner/effect_envelope_pass.rb +9 -4
- data/lib/rigor/analysis/runner/pool_coordinator.rb +107 -15
- data/lib/rigor/analysis/runner/project_pre_passes.rb +26 -7
- data/lib/rigor/analysis/runner.rb +278 -20
- data/lib/rigor/analysis/template_unit_collector.rb +303 -0
- data/lib/rigor/analysis/template_unit_paths.rb +91 -0
- data/lib/rigor/analysis/template_unit_positions.rb +293 -0
- data/lib/rigor/analysis/template_units.rb +399 -0
- data/lib/rigor/analysis/worker_session.rb +53 -10
- 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 +6 -1
- data/lib/rigor/cache/engine_source.rb +29 -1
- data/lib/rigor/cache/incremental_snapshot.rb +33 -1
- 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 +0 -1
- data/lib/rigor/ci_detector.rb +1 -0
- data/lib/rigor/cli/doc_links.rb +1 -1
- data/lib/rigor/cli/docs_command.rb +4 -4
- 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.rb +21 -3
- data/lib/rigor/configuration/severity_profile.rb +19 -3
- data/lib/rigor/configuration.rb +66 -3
- 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 +43 -31
- 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/lockfile_resolver.rb +17 -0
- data/lib/rigor/environment/member_consistency/comparator.rb +708 -0
- data/lib/rigor/environment/member_consistency.rb +298 -0
- data/lib/rigor/environment/rbs_loader.rb +399 -133
- data/lib/rigor/environment.rb +103 -38
- 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 +73 -27
- 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 +387 -15
- data/lib/rigor/inference/closure_escape_analyzer.rb +157 -13
- data/lib/rigor/inference/content_join.rb +200 -27
- 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/element_read_widening.rb +22 -10
- data/lib/rigor/inference/error_info.rb +196 -0
- data/lib/rigor/inference/expression_typer.rb +1532 -496
- data/lib/rigor/inference/external_ancestor_resolution.rb +267 -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 +447 -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 +167 -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 +881 -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/multi_target_binder.rb +340 -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 +540 -120
- 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 +3 -2
- 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.rb +4615 -551
- data/lib/rigor/inference/statement_evaluator.rb +3176 -490
- 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 +168 -5
- 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/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.rb +1 -0
- data/lib/rigor/protection/discovery_seed.rb +3 -1
- data/lib/rigor/protection/kill_signature.rb +0 -1
- data/lib/rigor/protection/mutation_cache.rb +1 -2
- data/lib/rigor/rbs_extended.rb +27 -0
- data/lib/rigor/reflection/constant_ancestors.rb +97 -0
- data/lib/rigor/reflection/constant_path.rb +19 -6
- data/lib/rigor/reflection.rb +72 -105
- data/lib/rigor/scope/discovery_index.rb +135 -2
- data/lib/rigor/scope.rb +859 -49
- 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 +558 -31
- 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 +88 -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-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 +12 -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 +1 -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 +135 -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 +9 -7
- data/skills/rigor-project-init/references/01-detect.md +13 -9
- data/skills/rigor-project-init/references/02-configure.md +33 -8
- 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 +108 -1
|
@@ -14,8 +14,16 @@ require_relative "../source/node_children"
|
|
|
14
14
|
require_relative "../inference/def_return_typer"
|
|
15
15
|
require_relative "../inference/scope_indexer"
|
|
16
16
|
require_relative "../inference/rbs_type_translator"
|
|
17
|
+
require_relative "alias_index"
|
|
17
18
|
require_relative "meta_class_shape"
|
|
18
19
|
require_relative "rbs_validity"
|
|
20
|
+
require_relative "classification"
|
|
21
|
+
require_relative "effect_annotation"
|
|
22
|
+
require_relative "declaration_equivalence"
|
|
23
|
+
require_relative "inline_declarations"
|
|
24
|
+
require_relative "layout_index"
|
|
25
|
+
require_relative "method_candidate"
|
|
26
|
+
require_relative "writer"
|
|
19
27
|
|
|
20
28
|
module Rigor
|
|
21
29
|
module SigGen
|
|
@@ -44,6 +52,15 @@ module Rigor
|
|
|
44
52
|
# - A declared `void` return is never compared as a value type. It is the author's statement that the
|
|
45
53
|
# return is not part of the contract, which no inference can synthesize, so the method classifies
|
|
46
54
|
# `equivalent` carrying `void` itself as the declared spelling (#836; see {#declares_void?}).
|
|
55
|
+
# - A declared `untyped` return (the RBS `Bases::Any` spelling, including the one ADR-93 synthesizes for
|
|
56
|
+
# a parameter-only inline `# @rbs` annotation) is the ABSENCE of a return statement, not the author's
|
|
57
|
+
# word about it — the opposite of `void`. It is treated like no declaration at all: the inferred return
|
|
58
|
+
# is proposed as `tighter-return`, carrying `untyped` as the declared spelling so `--diff` still shows a
|
|
59
|
+
# declaration existed (#995; see {#declared_untyped?}).
|
|
60
|
+
# - A `tighter-return` over the class's own declaration replaces the return and nothing else: the rest of
|
|
61
|
+
# the line is the declaration's, spelled as written, so `--overwrite` never changes which calls the
|
|
62
|
+
# signature accepts. A declaration with more than one overload, or one spelled as an `alias`, is left
|
|
63
|
+
# alone (#1436; see {#tighter_return_line}).
|
|
47
64
|
# - A proposal that erases to an RBS literal never tightens an existing declaration: the declared type is
|
|
48
65
|
# the author's abstraction over the body and the literal is what it hides (#837; see
|
|
49
66
|
# {#pins_literal_over_declaration?}). A method with no declaration is unaffected — clause 1 still emits
|
|
@@ -62,11 +79,18 @@ module Rigor
|
|
|
62
79
|
# produced by {ObservationCollector}. An empty Hash (the default)
|
|
63
80
|
# means "no observations available; emit `untyped` for every
|
|
64
81
|
# parameter position" per ADR-5 clause 2.
|
|
65
|
-
|
|
82
|
+
# @param overwrite — `--overwrite`: a member declared inline whose `sig/` copy disagrees is proposed as an
|
|
83
|
+
# `inline-overwrite` of the whole member instead of refused (ADR-112 WD4).
|
|
84
|
+
def initialize(configuration:, paths:, observations: {}, include_private: false, effect_annotator: nil,
|
|
85
|
+
overwrite: false)
|
|
66
86
|
@configuration = configuration
|
|
87
|
+
@overwrite = overwrite
|
|
67
88
|
@paths = paths
|
|
68
89
|
@observations = normalize_observations(observations)
|
|
69
90
|
@include_private = include_private
|
|
91
|
+
# ADR-103 WD9 — `nil` when the project's `effects:` opt-in is off, which is what keeps an
|
|
92
|
+
# effects-off run byte-identical to one from before the annotation slot was filled.
|
|
93
|
+
@effect_annotator = effect_annotator
|
|
70
94
|
# Per-file scratch state. `analyse_file` resets each one to a fresh container for every file walked so
|
|
71
95
|
# candidates from one file don't leak into another; initialising empty here gives downstream consumers
|
|
72
96
|
# (`build_candidate`, `method_def_prefix`) a never-nil invariant without per-call-site defensive guards.
|
|
@@ -96,13 +120,99 @@ module Rigor
|
|
|
96
120
|
resolved = resolve_paths(@paths)
|
|
97
121
|
@environment = build_environment(resolved)
|
|
98
122
|
candidates = resolved.flat_map { |path| analyse_file(path, @environment) }
|
|
99
|
-
|
|
100
|
-
|
|
123
|
+
annotate_effects(
|
|
124
|
+
demote_overridden_base_methods(
|
|
125
|
+
demote_unresolvable_superclasses(demote_inline_generic_classes(resolve_superclass_spellings(candidates)))
|
|
126
|
+
)
|
|
101
127
|
)
|
|
102
128
|
end
|
|
103
129
|
|
|
104
130
|
private
|
|
105
131
|
|
|
132
|
+
# ADR-103 WD9 — the annotation-emission slot ADR-14 reserved, run LAST so a candidate a later
|
|
133
|
+
# demotion turns into a skip never carries an annotation it will not print. Only emittable rows are
|
|
134
|
+
# asked: an annotation is a claim attached to a line, and a row that produces no line makes none.
|
|
135
|
+
def annotate_effects(candidates)
|
|
136
|
+
return candidates if @effect_annotator.nil?
|
|
137
|
+
|
|
138
|
+
candidates.map do |candidate|
|
|
139
|
+
next candidate unless Classification::EMITTABLE.include?(candidate.classification)
|
|
140
|
+
|
|
141
|
+
annotations, reason = @effect_annotator.annotate(
|
|
142
|
+
class_name: candidate.class_name, method_name: candidate.method_name, kind: candidate.kind,
|
|
143
|
+
path: candidate.path
|
|
144
|
+
)
|
|
145
|
+
reason.nil? && annotations.empty? ? candidate : candidate.with_effect_annotation(annotations, reason)
|
|
146
|
+
end
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# ADR-112 WD4 — nothing is written that would open a class an inline declaration makes generic (`# @rbs
|
|
150
|
+
# generic T`), or a namespace nested in one, in a file the project's `sig/` does not already declare it in;
|
|
151
|
+
# nor into a `sig/` declaration of the class whose type parameters are named otherwise (`class Box[U]`
|
|
152
|
+
# beside an inline `Box[T]`, which rbs accepts), where a copied `-> T` would name a parameter nothing binds.
|
|
153
|
+
#
|
|
154
|
+
# The writer spells a class header without type parameters, and rbs rejects a class whose declarations
|
|
155
|
+
# disagree on them (`GenericParameterMismatchError`): the class, and every class whose signature mentions
|
|
156
|
+
# it, fails its definition build and reads `Dynamic[top]` — while `rigor check` still exits 0. Skipping
|
|
157
|
+
# costs the generic class its `sig/` members; the inline declaration still binds when the source is
|
|
158
|
+
# analysed. A class `sig/` already declares is written into that declaration, whose parameters are the
|
|
159
|
+
# project's own.
|
|
160
|
+
def demote_inline_generic_classes(candidates)
|
|
161
|
+
generic = inline_declarations.generic_classes
|
|
162
|
+
return candidates if generic.empty?
|
|
163
|
+
|
|
164
|
+
layout = LayoutIndex.new(signature_paths: @configuration.signature_paths)
|
|
165
|
+
candidates.map do |candidate|
|
|
166
|
+
next candidate unless Classification::EMITTABLE.include?(candidate.classification)
|
|
167
|
+
next candidate unless unsafe_for_generic?(candidate.class_name, generic, layout)
|
|
168
|
+
|
|
169
|
+
demoted_candidate(candidate, :inline_generic_class)
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
def unsafe_for_generic?(class_name, generic, layout)
|
|
174
|
+
return false if class_name.nil?
|
|
175
|
+
|
|
176
|
+
file = layout.file_for(class_name)
|
|
177
|
+
return opens_generic_class?(class_name, generic) if file.nil?
|
|
178
|
+
|
|
179
|
+
generic.key?(class_name) && signature_type_params(file, class_name) != generic.fetch(class_name)
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# The type parameter names `file` declares `class_name` with; nil when it cannot be read, which counts as
|
|
183
|
+
# a mismatch — writing into a declaration whose parameters are unknown is the unsafe direction.
|
|
184
|
+
def signature_type_params(file, class_name)
|
|
185
|
+
@signature_type_params ||= {}
|
|
186
|
+
@signature_type_params.fetch([file, class_name]) do
|
|
187
|
+
@signature_type_params[[file, class_name]] = read_signature_type_params(file, class_name)
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
def read_signature_type_params(file, class_name)
|
|
192
|
+
_buffer, _directives, decls = ::RBS::Parser.parse_signature(File.read(file))
|
|
193
|
+
find_declaration(decls, [], class_name)&.type_params&.map(&:name)
|
|
194
|
+
rescue StandardError
|
|
195
|
+
nil
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
def find_declaration(decls, prefix, class_name)
|
|
199
|
+
decls.each do |decl|
|
|
200
|
+
next unless decl.is_a?(::RBS::AST::Declarations::Class) || decl.is_a?(::RBS::AST::Declarations::Module)
|
|
201
|
+
|
|
202
|
+
name = (prefix + [decl.name.to_s.delete_prefix("::")]).join("::")
|
|
203
|
+
return decl if name == class_name
|
|
204
|
+
|
|
205
|
+
found = find_declaration(decl.members, name.split("::"), class_name)
|
|
206
|
+
return found if found
|
|
207
|
+
end
|
|
208
|
+
nil
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
def opens_generic_class?(class_name, generic)
|
|
212
|
+
segments = class_name.split("::")
|
|
213
|
+
(1..segments.size).any? { |n| generic.key?(segments.first(n).join("::")) }
|
|
214
|
+
end
|
|
215
|
+
|
|
106
216
|
# Issue #744 — a base class's method is NOT emitted when a project subclass overrides it and the
|
|
107
217
|
# override is not emitted itself.
|
|
108
218
|
#
|
|
@@ -229,7 +339,8 @@ module Rigor
|
|
|
229
339
|
inferred_return: candidate.inferred_return, declared_return_rbs: candidate.declared_return_rbs,
|
|
230
340
|
rbs: candidate.rbs, skip_reason: candidate.skip_reason,
|
|
231
341
|
namespace_kinds: candidate.namespace_kinds, class_shells: candidate.class_shells,
|
|
232
|
-
class_superclasses: superclasses
|
|
342
|
+
class_superclasses: superclasses, declared_rbs: candidate.declared_rbs,
|
|
343
|
+
declared_annotations: candidate.declared_annotations
|
|
233
344
|
)
|
|
234
345
|
end
|
|
235
346
|
|
|
@@ -678,10 +789,22 @@ module Rigor
|
|
|
678
789
|
# `ObservationCollector`'s `.new` → `:initialize` routing), positional and keyword arg types come from the
|
|
679
790
|
# per-position / per-keyword union of observed types; otherwise every position keeps `untyped` per ADR-5
|
|
680
791
|
# clause 2.
|
|
681
|
-
|
|
792
|
+
#
|
|
793
|
+
# Issue #1436 — a constructor the class's own `sig/` already declares is `equivalent`, like any other
|
|
794
|
+
# declared member, unless the stub clears an `untyped` the declaration still carries: that is the
|
|
795
|
+
# `--params=observed` upgrade `--overwrite` applies ({Writer.fewer_untyped?}, the writer's own test).
|
|
796
|
+
# Without observations the stub is all `untyped` and never qualifies, so it is never listed as new.
|
|
797
|
+
def initialize_stub_candidate(path, def_node, class_name, scope)
|
|
682
798
|
params = def_node.parameters
|
|
683
799
|
rbs = "def initialize: (#{render_param_list(params, class_name, :initialize)})" \
|
|
684
800
|
"#{block_signature_suffix(params)} -> void"
|
|
801
|
+
method_def = lookup_existing_method(class_name, :initialize, :instance, scope&.environment, scope)
|
|
802
|
+
member = signature_member(method_def, class_name)
|
|
803
|
+
if member && !Writer.fewer_untyped?(rbs, member.location&.source.to_s)
|
|
804
|
+
declared = declares_void?(method_def) ? VOID_RETURN_RBS : build_declared_return(method_def)&.erase_to_rbs
|
|
805
|
+
return equivalent(path, def_node, class_name, :instance, Type::Combinator.untyped, declared)
|
|
806
|
+
end
|
|
807
|
+
|
|
685
808
|
build_candidate(
|
|
686
809
|
path: path, class_name: class_name, method_name: :initialize,
|
|
687
810
|
kind: :instance, classification: Classification::NEW_METHOD,
|
|
@@ -706,12 +829,12 @@ module Rigor
|
|
|
706
829
|
|
|
707
830
|
observations = arity_matched_observations(class_name, method_name, params)
|
|
708
831
|
parts = []
|
|
709
|
-
params.requireds.each_index { |i| parts << positional_type(observations, i, "") }
|
|
832
|
+
params.requireds.each_index { |i| parts << positional_type(observations, i, "", class_name) }
|
|
710
833
|
offset = params.requireds.size
|
|
711
|
-
params.optionals.each_index { |i| parts << positional_type(observations, offset + i, "?") }
|
|
834
|
+
params.optionals.each_index { |i| parts << positional_type(observations, offset + i, "?", class_name) }
|
|
712
835
|
parts << "*untyped" if params.rest
|
|
713
836
|
parts.concat(Array.new(params.posts.size, "untyped"))
|
|
714
|
-
params.keywords.each { |kw| parts << render_keyword_param(kw, observations) }
|
|
837
|
+
params.keywords.each { |kw| parts << render_keyword_param(kw, observations, class_name) }
|
|
715
838
|
parts.concat(keyword_rest_parts(params))
|
|
716
839
|
parts.join(", ")
|
|
717
840
|
end
|
|
@@ -761,15 +884,15 @@ module Rigor
|
|
|
761
884
|
|
|
762
885
|
# A bare union is a valid positional type in RBS (`(String | Integer, ?String | Integer)`), so unlike the
|
|
763
886
|
# return position it is not parenthesised.
|
|
764
|
-
def positional_type(observations, index, prefix)
|
|
887
|
+
def positional_type(observations, index, prefix, owner = nil)
|
|
765
888
|
types = observations.filter_map { |obs| obs.positional[index] }
|
|
766
|
-
"#{prefix}#{union_erase(types)}"
|
|
889
|
+
"#{prefix}#{union_erase(types, owner: owner)}"
|
|
767
890
|
end
|
|
768
891
|
|
|
769
|
-
def render_keyword_param(keyword, observations)
|
|
892
|
+
def render_keyword_param(keyword, observations, owner = nil)
|
|
770
893
|
optional_marker = keyword.is_a?(Prism::OptionalKeywordParameterNode) ? "?" : ""
|
|
771
894
|
types = observations.filter_map { |obs| obs.keyword[keyword.name] }
|
|
772
|
-
rendered = types.empty? ? "untyped" : paren_wrap_union(union_erase(types))
|
|
895
|
+
rendered = types.empty? ? "untyped" : paren_wrap_union(union_erase(types, owner: owner))
|
|
773
896
|
"#{optional_marker}#{keyword.name}: #{rendered}"
|
|
774
897
|
end
|
|
775
898
|
|
|
@@ -789,7 +912,15 @@ module Rigor
|
|
|
789
912
|
def classify_def(path, def_node, class_name, kind, scope_index)
|
|
790
913
|
return nil if visibility_excludes?(def_node, class_name, kind, scope_index)
|
|
791
914
|
return nil if initialize_excludes?(def_node, kind)
|
|
792
|
-
|
|
915
|
+
|
|
916
|
+
inline = inline_declarations.lookup(path, class_name, def_node.name, kind)
|
|
917
|
+
if inline
|
|
918
|
+
return skipped(path, def_node, class_name, kind, :inline_declared) if skip_inline_declared?
|
|
919
|
+
return inline_def_candidate(path, def_node, class_name, kind, scope_index, inline) if inline.declared?
|
|
920
|
+
end
|
|
921
|
+
if non_trivial_initialize?(def_node, kind)
|
|
922
|
+
return initialize_stub_candidate(path, def_node, class_name, scope_index[def_node])
|
|
923
|
+
end
|
|
793
924
|
|
|
794
925
|
inferred = infer_return_type(def_node, scope_index)
|
|
795
926
|
return skipped(path, def_node, class_name, kind, :untyped_return) if inferred.nil? || dynamic_top?(inferred)
|
|
@@ -804,6 +935,242 @@ module Rigor
|
|
|
804
935
|
end
|
|
805
936
|
end
|
|
806
937
|
|
|
938
|
+
# ADR-112 WD4 — the inline declarations of every analysed file, read once per run. See
|
|
939
|
+
# {InlineDeclarations} for why the synthesized text rather than the environment.
|
|
940
|
+
def inline_declarations
|
|
941
|
+
@inline_declarations ||= InlineDeclarations.build(@environment)
|
|
942
|
+
end
|
|
943
|
+
|
|
944
|
+
def skip_inline_declared?
|
|
945
|
+
@configuration.sig_gen_inline_declared == :skip
|
|
946
|
+
end
|
|
947
|
+
|
|
948
|
+
# ADR-112 WD4 — a `def` the author declared inline is written from that declaration, as rbs-inline reads it,
|
|
949
|
+
# not from what the body infers: `rigor check` reads the `sig/` member beside the inline one (ADR-112 WD5),
|
|
950
|
+
# so a line built from inference (`untyped` parameters, a return the body happens to prove) would override
|
|
951
|
+
# or contradict the contract the author wrote beside the code.
|
|
952
|
+
#
|
|
953
|
+
# The one inferred part is a return the author left unwritten (`# @rbs name: String`, no `return:`) —
|
|
954
|
+
# ADR-107's mixed provenance, parameters authored and return generated — filled from the body; a body that
|
|
955
|
+
# types as `untyped` there is skipped exactly as an undeclared one is. `initialize` returns `void` by
|
|
956
|
+
# definition, whatever its last expression is.
|
|
957
|
+
def inline_def_candidate(path, def_node, class_name, kind, scope_index, inline)
|
|
958
|
+
types = inline.method_types
|
|
959
|
+
return_defaulted = inline.return_inferred
|
|
960
|
+
if return_defaulted && initialize_def?(def_node, kind)
|
|
961
|
+
void = ::RBS::Types::Bases::Void.new(location: nil)
|
|
962
|
+
types = types.map { |mt| defaulted_return?(mt) ? with_return_type(mt, void) : mt }
|
|
963
|
+
return_defaulted = false
|
|
964
|
+
end
|
|
965
|
+
|
|
966
|
+
scope = scope_index[def_node]
|
|
967
|
+
method_def = lookup_existing_method(class_name, def_node.name, kind, scope&.environment, scope)
|
|
968
|
+
head = "#{method_def_prefix(class_name, def_node.name, kind)}#{def_node.name}: "
|
|
969
|
+
if return_defaulted
|
|
970
|
+
return mixed_provenance_candidate(path, def_node, class_name, kind, scope_index, inline, method_def, head)
|
|
971
|
+
end
|
|
972
|
+
|
|
973
|
+
inline_candidate(path, class_name, def_node.name, kind, head + types.join(" | "), inline, method_def)
|
|
974
|
+
end
|
|
975
|
+
|
|
976
|
+
# A parameter-only annotation (`# @rbs name: String`, no `return:`): parameters authored, return inferred.
|
|
977
|
+
# Only the authored half is weighed against `sig/`. When the parameters differ the method is refused, even
|
|
978
|
+
# under `--overwrite` — the body is typed under the parameters the environment binds, which are `sig/`'s
|
|
979
|
+
# once it declares the member, so a return inferred for the new line would describe parameters about to
|
|
980
|
+
# change. When they match, the return is an ordinary inferred proposal: {#compare_against_declared}
|
|
981
|
+
# leaves a declared `void`, a deliberately wider type and a declined literal alone, and proposes a
|
|
982
|
+
# strictly narrower return as `tighter-return`, spelled with the authored parameters.
|
|
983
|
+
def mixed_provenance_candidate(path, def_node, class_name, kind, scope_index, inline, method_def, head) # rubocop:disable Metrics/ParameterLists
|
|
984
|
+
types = inline.method_types
|
|
985
|
+
existing = signature_member(method_def, class_name)
|
|
986
|
+
if existing && parameters_differ?(existing, types, def_node.name, class_name)
|
|
987
|
+
return skipped(path, def_node, class_name, kind, :inline_differs)
|
|
988
|
+
end
|
|
989
|
+
|
|
990
|
+
inferred, overloads = inferred_overloads(def_node, scope_index, class_name, types)
|
|
991
|
+
return skipped(path, def_node, class_name, kind, :untyped_return) if inferred.nil?
|
|
992
|
+
|
|
993
|
+
rbs = head + overloads.join(" | ")
|
|
994
|
+
if existing && annotations_present?(existing, inline) && existing_types(existing, def_node.name)
|
|
995
|
+
return compare_against_declared(path, def_node, class_name, kind, inferred, method_def, rendered: rbs)
|
|
996
|
+
end
|
|
997
|
+
|
|
998
|
+
inline_candidate(path, class_name, def_node.name, kind, rbs, inline, method_def, inferred)
|
|
999
|
+
end
|
|
1000
|
+
|
|
1001
|
+
# `[inferred return, overload strings]`, or `[nil, nil]` when the body types as `untyped`.
|
|
1002
|
+
def inferred_overloads(def_node, scope_index, class_name, types)
|
|
1003
|
+
inferred = infer_return_type(def_node, scope_index)
|
|
1004
|
+
return [nil, nil] if inferred.nil? || dynamic_top?(inferred)
|
|
1005
|
+
|
|
1006
|
+
[inferred, with_defaulted_return(types, paren_wrap_union(elaborated_rbs(inferred, owner: class_name)))]
|
|
1007
|
+
end
|
|
1008
|
+
|
|
1009
|
+
# Whether a `sig/` member's overloads, returns aside, differ from the inline declaration's. Such a member is
|
|
1010
|
+
# refused even under `--overwrite` when the inline return is to be inferred (see {#inline_def_candidate});
|
|
1011
|
+
# deleting the `sig/` member lets the next run infer it under the inline parameters.
|
|
1012
|
+
def parameters_differ?(existing, types, method_name, class_name)
|
|
1013
|
+
written = existing_types(existing, method_name)
|
|
1014
|
+
return false if written.nil?
|
|
1015
|
+
|
|
1016
|
+
!equivalence(class_name).same_parameters?(written, types)
|
|
1017
|
+
end
|
|
1018
|
+
|
|
1019
|
+
def initialize_def?(def_node, kind)
|
|
1020
|
+
kind == :instance && def_node.name == :initialize
|
|
1021
|
+
end
|
|
1022
|
+
|
|
1023
|
+
def defaulted_return?(method_type)
|
|
1024
|
+
method_type.type.return_type.is_a?(::RBS::Types::Bases::Any)
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
def with_return_type(method_type, return_type)
|
|
1028
|
+
method_type.update(type: method_type.type.with_return_type(return_type))
|
|
1029
|
+
end
|
|
1030
|
+
|
|
1031
|
+
# A class name no project declares, standing in for the inferred return while `RBS::MethodType#to_s` spells
|
|
1032
|
+
# the rest of an overload, so the return itself keeps sig-gen's own spelling (`[Float, String]`, a folded
|
|
1033
|
+
# alias) rather than being re-spelled through a parse.
|
|
1034
|
+
INFERRED_RETURN_PLACEHOLDER = "Rigor__SigGenInferredReturn"
|
|
1035
|
+
private_constant :INFERRED_RETURN_PLACEHOLDER
|
|
1036
|
+
|
|
1037
|
+
# Each overload whose return rbs-inline defaulted to `untyped` takes `returned` (already spelled for a
|
|
1038
|
+
# return position); the rest stay as written.
|
|
1039
|
+
def with_defaulted_return(method_types, returned)
|
|
1040
|
+
method_types.map do |method_type|
|
|
1041
|
+
defaulted_return?(method_type) ? spell_with_return(method_type, returned) : method_type.to_s
|
|
1042
|
+
end
|
|
1043
|
+
end
|
|
1044
|
+
|
|
1045
|
+
# One overload spelled with `returned` (already spelled for a return position) as its return.
|
|
1046
|
+
def spell_with_return(method_type, returned)
|
|
1047
|
+
placeholder = ::RBS::Parser.parse_type(INFERRED_RETURN_PLACEHOLDER)
|
|
1048
|
+
with_return_type(method_type, placeholder).to_s.sub(/-> #{INFERRED_RETURN_PLACEHOLDER}\z/o, "-> #{returned}")
|
|
1049
|
+
end
|
|
1050
|
+
|
|
1051
|
+
# Classifies an inline-declared member's `rbs` line against what `sig/` already says for it (ADR-112 WD4, as
|
|
1052
|
+
# decided on #1422):
|
|
1053
|
+
#
|
|
1054
|
+
# - nothing on this class itself (or only the inline declaration) — `new-method`;
|
|
1055
|
+
# - the same types, and every annotation the author wrote inline — `equivalent`;
|
|
1056
|
+
# - anything else — the two declarations disagree, and neither is presumed right. Without `--overwrite`
|
|
1057
|
+
# the member is REFUSED (`sig.skipped.inline-differs`): nothing is written, and `--write` / `--check`
|
|
1058
|
+
# exit 1 until a person reconciles them. With `--overwrite` it is `inline-overwrite`, which replaces the
|
|
1059
|
+
# whole `sig/` member with the inline line — never a mix of the two, whose slots (and type variables)
|
|
1060
|
+
# need not correspond.
|
|
1061
|
+
def inline_candidate(path, class_name, method_name, kind, rbs, inline, method_def, inferred = nil) # rubocop:disable Metrics/ParameterLists
|
|
1062
|
+
fields = { path: path, class_name: class_name, method_name: method_name, kind: kind,
|
|
1063
|
+
inferred_return: inferred }
|
|
1064
|
+
existing = signature_member(method_def, class_name)
|
|
1065
|
+
if existing.nil?
|
|
1066
|
+
build_candidate(**fields, classification: Classification::NEW_METHOD, rbs: rbs,
|
|
1067
|
+
declared_annotations: inline.annotation_lines)
|
|
1068
|
+
elsif current_copy?(existing, rbs, inline, method_name, class_name)
|
|
1069
|
+
build_candidate(**fields, classification: Classification::EQUIVALENT)
|
|
1070
|
+
elsif @overwrite
|
|
1071
|
+
# An `attr_*` member is replaced in its own spelling, by the inline attribute's.
|
|
1072
|
+
line = attr_member?(existing) && inline.attr_line ? inline.attr_line : rbs
|
|
1073
|
+
build_candidate(**fields, classification: Classification::INLINE_OVERWRITE, rbs: line,
|
|
1074
|
+
declared_annotations: inline.annotation_lines,
|
|
1075
|
+
declared_rbs: squish(existing.location&.source))
|
|
1076
|
+
else
|
|
1077
|
+
build_candidate(**fields, classification: Classification::SKIPPED, skip_reason: :inline_differs)
|
|
1078
|
+
end
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
# The member a project `.rbs` declares for `class_name` itself — not an ancestor's, and not the inline
|
|
1082
|
+
# declaration, whose buffer is the synthesizer's `virtual:` one. An `overloading?` member (`def x: … |
|
|
1083
|
+
# ...`) is not a counterpart either: it adds overloads to the inline declaration rather than restating
|
|
1084
|
+
# it, and sig-gen leaves it alone.
|
|
1085
|
+
def signature_member(method_def, class_name)
|
|
1086
|
+
return nil if method_def.nil?
|
|
1087
|
+
|
|
1088
|
+
method_def.defs.filter_map do |type_def|
|
|
1089
|
+
next unless type_def.defined_in.to_s.delete_prefix("::") == class_name
|
|
1090
|
+
|
|
1091
|
+
member = type_def.member
|
|
1092
|
+
next if member.respond_to?(:overloading?) && member.overloading?
|
|
1093
|
+
|
|
1094
|
+
member unless member.location&.buffer&.name.to_s.start_with?("virtual:")
|
|
1095
|
+
end.first
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1098
|
+
# The two declarations are compared as types ({DeclarationEquivalence}): parameter names, union spelling
|
|
1099
|
+
# and a leading `::` that resolves to the same constant do not count; overload order does. The copy must
|
|
1100
|
+
# also carry every annotation the author wrote inline. A `sig/` member whose text is unavailable is left
|
|
1101
|
+
# as it is rather than refused for good.
|
|
1102
|
+
def current_copy?(member, rbs, inline, method_name, class_name)
|
|
1103
|
+
written = existing_types(member, method_name)
|
|
1104
|
+
mine = member_types(rbs)
|
|
1105
|
+
return true if written.nil? || mine.nil?
|
|
1106
|
+
|
|
1107
|
+
equivalence(class_name).same?(written, mine) && annotations_present?(member, inline)
|
|
1108
|
+
end
|
|
1109
|
+
|
|
1110
|
+
def annotations_present?(member, inline)
|
|
1111
|
+
(inline.annotations - member.annotations.map { |annotation| annotation.string.to_s.strip }).empty?
|
|
1112
|
+
end
|
|
1113
|
+
|
|
1114
|
+
def attr_member?(member)
|
|
1115
|
+
member.is_a?(::RBS::AST::Members::AttrReader) || member.is_a?(::RBS::AST::Members::AttrWriter) ||
|
|
1116
|
+
member.is_a?(::RBS::AST::Members::AttrAccessor)
|
|
1117
|
+
end
|
|
1118
|
+
|
|
1119
|
+
# The overloads a `sig/` member declares for `method_name`: a `def`'s, parsed from its own text; an
|
|
1120
|
+
# attribute's reader (`() -> T`) or writer (`(T) -> T`), from its type.
|
|
1121
|
+
def existing_types(member, method_name)
|
|
1122
|
+
return member_types(member.location&.source) if member.is_a?(::RBS::AST::Members::MethodDefinition)
|
|
1123
|
+
return nil unless attr_member?(member)
|
|
1124
|
+
|
|
1125
|
+
shape = method_name.to_s.end_with?("=") ? "(#{member.type}) -> #{member.type}" : "() -> #{member.type}"
|
|
1126
|
+
[::RBS::Parser.parse_method_type(shape)]
|
|
1127
|
+
rescue ::RBS::BaseError
|
|
1128
|
+
nil
|
|
1129
|
+
end
|
|
1130
|
+
|
|
1131
|
+
def equivalence(class_name)
|
|
1132
|
+
@equivalence ||= {}
|
|
1133
|
+
@equivalence[class_name] ||= DeclarationEquivalence.new(resolve: type_name_resolver(class_name))
|
|
1134
|
+
end
|
|
1135
|
+
|
|
1136
|
+
# A type name as written, resolved the way RBS resolves it inside `class_name`'s declaration: an absolute
|
|
1137
|
+
# `::Foo` is `Foo`; a relative `Foo` is the innermost `…::Foo` the environment knows, so inside `module NS`
|
|
1138
|
+
# it is `NS::Foo` when `NS` declares one, and `::Foo` only when it does not.
|
|
1139
|
+
def type_name_resolver(class_name)
|
|
1140
|
+
nesting = class_name.split("::")
|
|
1141
|
+
lambda do |name|
|
|
1142
|
+
next name.delete_prefix("::") if name.start_with?("::")
|
|
1143
|
+
|
|
1144
|
+
nesting.size.downto(1).map { |n| (nesting.first(n) + [name]).join("::") }
|
|
1145
|
+
.find { |candidate| class_known?(candidate) } || name
|
|
1146
|
+
end
|
|
1147
|
+
end
|
|
1148
|
+
|
|
1149
|
+
def class_known?(name)
|
|
1150
|
+
@class_known ||= {}
|
|
1151
|
+
@class_known.fetch(name) { @class_known[name] = Reflection.rbs_class_known?(name, environment: @environment) }
|
|
1152
|
+
end
|
|
1153
|
+
|
|
1154
|
+
# A member line's overloads, parsed with type names unresolved so the two sides compare as written.
|
|
1155
|
+
def member_types(source)
|
|
1156
|
+
member_overloads(source)&.map(&:method_type)
|
|
1157
|
+
end
|
|
1158
|
+
|
|
1159
|
+
# The same, with each overload's own annotations (`%a{pure} (Integer) -> String`).
|
|
1160
|
+
def member_overloads(source)
|
|
1161
|
+
return nil if source.nil?
|
|
1162
|
+
|
|
1163
|
+
_buffer, _directives, decls = ::RBS::Parser.parse_signature("class Rigor__SigGenProbe\n#{source}\nend\n")
|
|
1164
|
+
parsed = decls.first&.members&.first
|
|
1165
|
+
parsed.is_a?(::RBS::AST::Members::MethodDefinition) ? parsed.overloads : nil
|
|
1166
|
+
rescue ::RBS::BaseError
|
|
1167
|
+
nil
|
|
1168
|
+
end
|
|
1169
|
+
|
|
1170
|
+
def squish(text)
|
|
1171
|
+
text.to_s.gsub(/\s+/, " ").strip
|
|
1172
|
+
end
|
|
1173
|
+
|
|
807
1174
|
# Mirrors the `def.return-type-mismatch` rule's body-type extraction: type the implicit-return expression
|
|
808
1175
|
# under the scope the indexer associated with the body. The parameter bindings (typed `untyped` per the
|
|
809
1176
|
# indexer's default) come from `with_local` inside `StatementEvaluator`; the result is the carrier the
|
|
@@ -813,9 +1180,10 @@ module Rigor
|
|
|
813
1180
|
# types with the implicit-return expression's type. The earlier MVP only typed the implicit-return path,
|
|
814
1181
|
# which routinely produced single-branch artefacts like `parse_options: () -> nil` (the actual runtime
|
|
815
1182
|
# return is `options | nil`) or `find: () -> V` (actually `V | nil` via `return nil unless ...`). The walk
|
|
816
|
-
#
|
|
817
|
-
#
|
|
818
|
-
#
|
|
1183
|
+
# includes a `return` inside an ordinary block, which exits the method, and excludes the
|
|
1184
|
+
# {Rigor::Inference::ReturnBarrier} bodies — nested `def`, lambda, `define_method` — whose returns belong to a
|
|
1185
|
+
# different method (issue #1382). Delegates to {Rigor::Inference::DefReturnTyper} — the same body-typing +
|
|
1186
|
+
# explicit-return-union the `rigor annotate` def-line annotator uses.
|
|
819
1187
|
def infer_return_type(def_node, scope_index)
|
|
820
1188
|
Inference::DefReturnTyper.call(def_node, scope_index)
|
|
821
1189
|
end
|
|
@@ -858,10 +1226,16 @@ module Rigor
|
|
|
858
1226
|
VOID_RETURN_RBS = "void"
|
|
859
1227
|
private_constant :VOID_RETURN_RBS
|
|
860
1228
|
|
|
861
|
-
|
|
1229
|
+
# @param rendered — the line a proposal is spelled as when it is not the ordinary inferred one: a
|
|
1230
|
+
# parameter-only inline annotation keeps its authored parameters ({#mixed_provenance_candidate}).
|
|
1231
|
+
def compare_against_declared(path, def_node, class_name, kind, inferred, method_def, rendered: nil)
|
|
862
1232
|
return equivalent(path, def_node, class_name, kind, inferred, VOID_RETURN_RBS) if declares_void?(method_def)
|
|
863
1233
|
|
|
864
1234
|
declared = build_declared_return(method_def)
|
|
1235
|
+
if declared_untyped?(declared)
|
|
1236
|
+
return declared_untyped_candidate(path, def_node, class_name, kind, inferred, method_def, rendered: rendered)
|
|
1237
|
+
end
|
|
1238
|
+
|
|
865
1239
|
declared_rbs = declared&.erase_to_rbs
|
|
866
1240
|
inferred_rbs = inferred.erase_to_rbs
|
|
867
1241
|
|
|
@@ -873,6 +1247,17 @@ module Rigor
|
|
|
873
1247
|
return equivalent(path, def_node, class_name, kind, inferred, declared_rbs)
|
|
874
1248
|
end
|
|
875
1249
|
|
|
1250
|
+
tighter_return_candidate(path, def_node, class_name, kind, inferred, method_def, declared_rbs, rendered)
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
# Both tightening branches end here. The proposal is the declaration with its return replaced
|
|
1254
|
+
# ({#tighter_return_line}); when there is no single declared overload to replace it in, the method is
|
|
1255
|
+
# `equivalent` — the declaration stands, as it does for any narrowing the generator declines. `declared_rbs`
|
|
1256
|
+
# carries the class's own declaration so `--diff` and `--check` show the line the proposal replaces.
|
|
1257
|
+
def tighter_return_candidate(path, def_node, class_name, kind, inferred, method_def, declared_return, rendered) # rubocop:disable Metrics/ParameterLists
|
|
1258
|
+
line = rendered || tighter_return_line(def_node, method_def, class_name, kind, inferred)
|
|
1259
|
+
return equivalent(path, def_node, class_name, kind, inferred, declared_return) if line.nil?
|
|
1260
|
+
|
|
876
1261
|
build_candidate(
|
|
877
1262
|
path: path,
|
|
878
1263
|
class_name: class_name,
|
|
@@ -880,11 +1265,68 @@ module Rigor
|
|
|
880
1265
|
kind: kind,
|
|
881
1266
|
classification: Classification::TIGHTER_RETURN,
|
|
882
1267
|
inferred_return: inferred,
|
|
883
|
-
declared_return_rbs:
|
|
884
|
-
|
|
1268
|
+
declared_return_rbs: declared_return,
|
|
1269
|
+
declared_rbs: declared_line(method_def, class_name),
|
|
1270
|
+
rbs: line
|
|
885
1271
|
)
|
|
886
1272
|
end
|
|
887
1273
|
|
|
1274
|
+
# Issue #1436 — a `tighter-return` changes the return and only the return. It used to be rendered like a
|
|
1275
|
+
# new method, from the `def`'s runtime shape: every parameter `untyped`, `(?)` spelled out as
|
|
1276
|
+
# `(*untyped)`, names and block types dropped. Under `--overwrite` that replaced a declared `(Integer x)`
|
|
1277
|
+
# with `(untyped)` — a change to which calls the signature accepts, made by a proposal that claims to be
|
|
1278
|
+
# about the return. The class's own declaration is kept whole instead: its visibility, the overload's
|
|
1279
|
+
# annotations, type parameters, parameters and block, with only the return replaced.
|
|
1280
|
+
#
|
|
1281
|
+
# Three shapes are declined (`nil`):
|
|
1282
|
+
# - several overloads. The body is typed once, so the inferred return covers every overload together and
|
|
1283
|
+
# says nothing about which overload returns what: collapsing them into one line would drop the
|
|
1284
|
+
# overloads, and giving each the joint return would widen the overloads the author wrote narrower.
|
|
1285
|
+
# - a name the class's own `sig/` spells as an `alias`. Its parameters are the aliased method's, and a
|
|
1286
|
+
# proposal would read as a rewrite of that method's line rather than of the alias. An alias only an
|
|
1287
|
+
# ancestor declares takes the override path below, like any other ancestor declaration.
|
|
1288
|
+
# - nothing else: when only an ancestor declares the method, the proposal is a new override on this
|
|
1289
|
+
# class, and is rendered from the `def`'s own shape like any new method. The ancestor's parameters
|
|
1290
|
+
# describe the ancestor's `def`, not this one, which may take other arguments (ADR-14 clause 2).
|
|
1291
|
+
def tighter_return_line(def_node, method_def, class_name, kind, inferred)
|
|
1292
|
+
member = signature_member(method_def, class_name)
|
|
1293
|
+
return render_rbs_line(def_node, inferred, class_name, kind) if member.nil?
|
|
1294
|
+
return nil if method_def.alias_of
|
|
1295
|
+
|
|
1296
|
+
overload = sole_declared_overload(member, method_def, def_node.name)
|
|
1297
|
+
return nil if overload.nil?
|
|
1298
|
+
|
|
1299
|
+
returned = paren_wrap_union(elaborated_rbs(inferred, owner: class_name))
|
|
1300
|
+
annotations = overload.annotations.map { |a| "#{a.location&.source || "%a{#{a.string}}"} " }.join
|
|
1301
|
+
visibility = member.respond_to?(:visibility) && member.visibility ? "#{member.visibility} " : ""
|
|
1302
|
+
"#{visibility}#{method_def_prefix(class_name, def_node.name, kind)}#{def_node.name}: " \
|
|
1303
|
+
"#{annotations}#{spell_with_return(overload.method_type, returned)}"
|
|
1304
|
+
end
|
|
1305
|
+
|
|
1306
|
+
# The one overload the class's own `sig/` member declares, parsed from its text with its annotations so it
|
|
1307
|
+
# keeps the spelling the author wrote (`Integer`, not the resolved `::Integer`). An attribute declares one
|
|
1308
|
+
# implicitly and carries no overload annotations.
|
|
1309
|
+
def sole_declared_overload(member, method_def, method_name)
|
|
1310
|
+
return nil unless method_def.method_types.size == 1
|
|
1311
|
+
|
|
1312
|
+
overloads =
|
|
1313
|
+
if member.is_a?(::RBS::AST::Members::MethodDefinition)
|
|
1314
|
+
member_overloads(member.location&.source)
|
|
1315
|
+
else
|
|
1316
|
+
existing_types(member, method_name)&.map do |method_type|
|
|
1317
|
+
::RBS::AST::Members::MethodDefinition::Overload.new(method_type: method_type, annotations: [])
|
|
1318
|
+
end
|
|
1319
|
+
end
|
|
1320
|
+
overloads&.size == 1 ? overloads.first : nil
|
|
1321
|
+
end
|
|
1322
|
+
|
|
1323
|
+
# The class's own declaration, as the `-` line of `--diff` and `--check` shows it. A method only an
|
|
1324
|
+
# ancestor declares has none: the proposal adds an override rather than replacing a line.
|
|
1325
|
+
def declared_line(method_def, class_name)
|
|
1326
|
+
source = signature_member(method_def, class_name)&.location&.source
|
|
1327
|
+
source && squish(source)
|
|
1328
|
+
end
|
|
1329
|
+
|
|
888
1330
|
# Issue #836 — a declared `void` is return INTENT, never a wide value type waiting to be narrowed, so it
|
|
889
1331
|
# is not compared against the body at all.
|
|
890
1332
|
#
|
|
@@ -907,6 +1349,27 @@ module Rigor
|
|
|
907
1349
|
method_def.method_types.any? { |mt| mt.type.return_type.is_a?(RBS::Types::Bases::Void) }
|
|
908
1350
|
end
|
|
909
1351
|
|
|
1352
|
+
# Issue #995 — a declared `untyped` (RBS `Bases::Any`, translated by
|
|
1353
|
+
# {Inference::RbsTypeTranslator} to `Type::Dynamic`) says nothing at all, unlike `void` (#836), which is
|
|
1354
|
+
# the author's word that the value is not part of the contract. `tighter?`'s acceptance check cannot
|
|
1355
|
+
# tell the two apart — `untyped` accepts and is accepted by everything, so its backward check, which
|
|
1356
|
+
# exists to refuse a declaration that carries real information the inferred form would narrow, also
|
|
1357
|
+
# refused this one — and the candidate fell into `equivalent`: neither emitted nor counted among the
|
|
1358
|
+
# skips. ADR-93's inline `# @rbs param: Type` annotation (no return clause) synthesizes exactly this
|
|
1359
|
+
# spelling for every method it documents, so the silent drop hit the parameter-annotated, return-bare
|
|
1360
|
+
# shape ADR-14 exists to help.
|
|
1361
|
+
def declared_untyped?(declared)
|
|
1362
|
+
declared.is_a?(Type::Dynamic)
|
|
1363
|
+
end
|
|
1364
|
+
|
|
1365
|
+
# Proposed without {#compare_against_declared}'s tightening guards: a declared `untyped` return carries no
|
|
1366
|
+
# information to weigh {#tighter?} or {#literal_decline?} against, the same position a method with no
|
|
1367
|
+
# declaration at all is in. The line is built as for any tightening ({#tighter_return_line}), and
|
|
1368
|
+
# `declared_return_rbs` carries `"untyped"` so the `[tighter, was: untyped]` print tag says one existed.
|
|
1369
|
+
def declared_untyped_candidate(path, def_node, class_name, kind, inferred, method_def, rendered: nil)
|
|
1370
|
+
tighter_return_candidate(path, def_node, class_name, kind, inferred, method_def, "untyped", rendered)
|
|
1371
|
+
end
|
|
1372
|
+
|
|
910
1373
|
def build_declared_return(method_def)
|
|
911
1374
|
translated = method_def.method_types.filter_map { |mt| translate_method_type_return(mt) }
|
|
912
1375
|
return nil if translated.empty?
|
|
@@ -914,10 +1377,19 @@ module Rigor
|
|
|
914
1377
|
translated.size == 1 ? translated.first : Type::Combinator.union(*translated)
|
|
915
1378
|
end
|
|
916
1379
|
|
|
1380
|
+
# `alias_expander:` matters here as much as it does at any dispatch site (see
|
|
1381
|
+
# {Inference::RbsTypeTranslator}'s own doc comment): without it, a declared return spelled as a
|
|
1382
|
+
# project alias (`Type::t`, `Environment::ordering`, `Inference::closure_classification`) degrades
|
|
1383
|
+
# to `Dynamic[Top]` exactly like a bare `untyped` would, and {#declared_untyped?} cannot tell an
|
|
1384
|
+
# author's meaningful alias apart from an absent declaration. That collapsed a well-typed, already
|
|
1385
|
+
# exact declaration into a spurious {#declared_untyped_candidate} the moment #995 made "declared
|
|
1386
|
+
# untyped" a proposable position — the ADR-107 G3 gate caught it on this repo's own `sig/` tree
|
|
1387
|
+
# (`Environment#class_ordering`'s `-> ordering` and every `-> Type::t` return in `type.rbs` /
|
|
1388
|
+
# `inference.rbs` / `scope.rbs`).
|
|
917
1389
|
def translate_method_type_return(method_type)
|
|
918
1390
|
Inference::RbsTypeTranslator.translate(
|
|
919
1391
|
method_type.type.return_type,
|
|
920
|
-
self_type: nil, instance_type: nil, type_vars: {}
|
|
1392
|
+
self_type: nil, instance_type: nil, type_vars: {}, alias_expander: @environment&.rbs_loader
|
|
921
1393
|
)
|
|
922
1394
|
rescue StandardError
|
|
923
1395
|
nil
|
|
@@ -1097,15 +1569,54 @@ module Rigor
|
|
|
1097
1569
|
params = def_node.parameters
|
|
1098
1570
|
head = "(#{render_param_list(params, class_name, def_node.name)})#{block_signature_suffix(params)}"
|
|
1099
1571
|
prefix = method_def_prefix(class_name, def_node.name, kind)
|
|
1100
|
-
"#{prefix}#{def_node.name}: #{head} -> #{paren_wrap_union(elaborated_rbs(inferred))}"
|
|
1572
|
+
"#{prefix}#{def_node.name}: #{head} -> #{paren_wrap_union(elaborated_rbs(inferred, owner: class_name))}"
|
|
1101
1573
|
end
|
|
1102
1574
|
|
|
1103
1575
|
# Routes the inferred carrier through {TypeElaborator} so bare generic nominals (`Array` / `Hash` / `Set`
|
|
1104
1576
|
# / `Range` / `Enumerable`) get their `untyped` type parameters filled in before erasing to RBS. The
|
|
1105
1577
|
# elaborator consults the class's RBS-declared type-parameter list via
|
|
1106
1578
|
# `Reflection.class_type_param_names`.
|
|
1107
|
-
|
|
1108
|
-
|
|
1579
|
+
# `owner:` is the class or module the rendered member belongs to. {AliasIndex} needs it to judge whether
|
|
1580
|
+
# a matching alias is one this reader would expect to see; a call site that cannot supply it renders the
|
|
1581
|
+
# type unfolded, which is the same output as before #1002.
|
|
1582
|
+
def elaborated_rbs(type, owner: nil)
|
|
1583
|
+
alias_index.fold(TypeElaborator.elaborate(type, environment: @environment).erase_to_rbs, owner)
|
|
1584
|
+
end
|
|
1585
|
+
|
|
1586
|
+
# Issue #1002 — the reverse of {#translate_method_type_return}'s `alias_expander:`. Folding happens here,
|
|
1587
|
+
# at the single seam every rendered type passes through (`render_rbs_line`, `union_erase` for parameter
|
|
1588
|
+
# and ivar positions, the attr path), so `--print`, `--diff`, `--write` and `--format=json` cannot drift
|
|
1589
|
+
# from one another: they all read the `rbs` string a candidate was built with. Deliberately NOT in
|
|
1590
|
+
# {Type::Union#erase_to_rbs} — that carrier method is the type model's RBS surface, shared with
|
|
1591
|
+
# diagnostics, `rigor type-of` and the engine's own comparisons, and none of those should start naming a
|
|
1592
|
+
# project alias. Sig-gen's rendering preference is a CLI concern and stays on the CLI side.
|
|
1593
|
+
def alias_index
|
|
1594
|
+
@alias_index ||= AliasIndex.build(
|
|
1595
|
+
environment: @environment,
|
|
1596
|
+
signature_paths: project_signature_paths,
|
|
1597
|
+
excluded_paths: plugin_signature_paths
|
|
1598
|
+
)
|
|
1599
|
+
end
|
|
1600
|
+
|
|
1601
|
+
# The project's OWN signature paths, resolved exactly as `Environment.for_project` resolves its
|
|
1602
|
+
# `resolved_paths` — the configured list, or `<root>/sig` when the project configured none. The
|
|
1603
|
+
# loader's `signature_paths` is NOT the same list: it also carries plugin signature paths, gem `sig/`
|
|
1604
|
+
# directories discovered under the project's bundle, the `rbs collection` tree and Rigor's own gem
|
|
1605
|
+
# overlays, none of which declare vocabulary this project chose.
|
|
1606
|
+
def project_signature_paths
|
|
1607
|
+
configured = @configuration.signature_paths
|
|
1608
|
+
return configured unless configured.nil?
|
|
1609
|
+
|
|
1610
|
+
default = Pathname(Dir.pwd) / "sig"
|
|
1611
|
+
default.directory? ? [default] : []
|
|
1612
|
+
end
|
|
1613
|
+
|
|
1614
|
+
# A loaded plugin's own signature directory is the plugin's vocabulary, not the project's, whether the
|
|
1615
|
+
# plugin tier contributed it or the project wired it into `signature_paths:` itself (#697).
|
|
1616
|
+
def plugin_signature_paths
|
|
1617
|
+
@environment&.plugin_registry&.signature_paths || []
|
|
1618
|
+
rescue StandardError
|
|
1619
|
+
[]
|
|
1109
1620
|
end
|
|
1110
1621
|
|
|
1111
1622
|
# RBS / Steep require return-position unions to be parenthesised when they appear bare at the top level of
|
|
@@ -1131,15 +1642,15 @@ module Rigor
|
|
|
1131
1642
|
false
|
|
1132
1643
|
end
|
|
1133
1644
|
|
|
1134
|
-
def union_erase(types)
|
|
1645
|
+
def union_erase(types, owner: nil)
|
|
1135
1646
|
return "untyped" if types.empty?
|
|
1136
|
-
return elaborated_rbs(types.first) if types.size == 1
|
|
1647
|
+
return elaborated_rbs(types.first, owner: owner) if types.size == 1
|
|
1137
1648
|
|
|
1138
1649
|
# `Type::Combinator.union` dedupes by structural type equality. The carrier-level `erase_to_rbs` now
|
|
1139
1650
|
# absorbs `untyped` members and dedupes the post-erase strings (`String | String` → `String` for
|
|
1140
1651
|
# distinct `Constant<"Alice">` / `Constant<"Bob">` envelopes), so the sig-gen layer only needs to
|
|
1141
1652
|
# elaborate bare generics before erasing.
|
|
1142
|
-
elaborated_rbs(Type::Combinator.union(*types))
|
|
1653
|
+
elaborated_rbs(Type::Combinator.union(*types), owner: owner)
|
|
1143
1654
|
end
|
|
1144
1655
|
|
|
1145
1656
|
# ADR-14 slice 4 — `attr_reader` / `attr_writer` / `attr_accessor` recognition. Each Symbol-named entry in
|
|
@@ -1155,6 +1666,7 @@ module Rigor
|
|
|
1155
1666
|
attr_writer: [:writer],
|
|
1156
1667
|
attr_accessor: %i[reader writer]
|
|
1157
1668
|
}.freeze
|
|
1669
|
+
Ractor.make_shareable(ATTR_KINDS)
|
|
1158
1670
|
private_constant :ATTR_KINDS
|
|
1159
1671
|
|
|
1160
1672
|
# Per-file context the attr_* walker threads through its recursive descent. Keeps parameter lists in
|
|
@@ -1363,6 +1875,12 @@ module Rigor
|
|
|
1363
1875
|
end
|
|
1364
1876
|
|
|
1365
1877
|
def build_attr_candidate(class_name, method_name, variant, ivar_type, ctx)
|
|
1878
|
+
inline = inline_declarations.lookup(ctx.path, class_name, method_name, :instance)
|
|
1879
|
+
if inline
|
|
1880
|
+
return attr_skipped(ctx.path, class_name, method_name, :inline_declared) if skip_inline_declared?
|
|
1881
|
+
return inline_attr_candidate(class_name, method_name, inline, ctx) if inline.declared?
|
|
1882
|
+
end
|
|
1883
|
+
|
|
1366
1884
|
if ivar_type.nil? || dynamic_top?(ivar_type)
|
|
1367
1885
|
return attr_skipped(ctx.path, class_name, method_name, :untyped_return)
|
|
1368
1886
|
end
|
|
@@ -1377,6 +1895,15 @@ module Rigor
|
|
|
1377
1895
|
end
|
|
1378
1896
|
end
|
|
1379
1897
|
|
|
1898
|
+
# ADR-112 WD4 — an attribute typed inline (`attr_reader :name #: String`) is written from that type, in
|
|
1899
|
+
# the long `def` form the rest of the attr path uses.
|
|
1900
|
+
def inline_attr_candidate(class_name, method_name, inline, ctx)
|
|
1901
|
+
scope = ctx.scope_index.each_value.first
|
|
1902
|
+
method_def = lookup_existing_method(class_name, method_name, :instance, scope&.environment, scope)
|
|
1903
|
+
rbs = "def #{method_name}: #{inline.method_types.join(' | ')}"
|
|
1904
|
+
inline_candidate(ctx.path, class_name, method_name, :instance, rbs, inline, method_def)
|
|
1905
|
+
end
|
|
1906
|
+
|
|
1380
1907
|
def attr_new_candidate(path, class_name, method_name, variant, ivar_type)
|
|
1381
1908
|
build_candidate(
|
|
1382
1909
|
path: path,
|
|
@@ -1385,7 +1912,7 @@ module Rigor
|
|
|
1385
1912
|
kind: :instance,
|
|
1386
1913
|
classification: Classification::NEW_METHOD,
|
|
1387
1914
|
inferred_return: ivar_type,
|
|
1388
|
-
rbs: render_attr_rbs_line(method_name, variant, ivar_type)
|
|
1915
|
+
rbs: render_attr_rbs_line(method_name, variant, ivar_type, class_name)
|
|
1389
1916
|
)
|
|
1390
1917
|
end
|
|
1391
1918
|
|
|
@@ -1402,7 +1929,7 @@ module Rigor
|
|
|
1402
1929
|
path: path, class_name: class_name, method_name: method_name,
|
|
1403
1930
|
kind: :instance, classification: Classification::TIGHTER_RETURN,
|
|
1404
1931
|
inferred_return: ivar_type, declared_return_rbs: declared_rbs,
|
|
1405
|
-
rbs: render_attr_rbs_line(method_name, variant, ivar_type)
|
|
1932
|
+
rbs: render_attr_rbs_line(method_name, variant, ivar_type, class_name)
|
|
1406
1933
|
)
|
|
1407
1934
|
end
|
|
1408
1935
|
|
|
@@ -1426,8 +1953,8 @@ module Rigor
|
|
|
1426
1953
|
# form can normalise post-emit; the writer-side member detection (slice 2) treats existing `attr_*`
|
|
1427
1954
|
# declarations as user-authored so a paired source-side `attr_reader` never produces a duplicate `def`
|
|
1428
1955
|
# insertion.
|
|
1429
|
-
def render_attr_rbs_line(method_name, variant, ivar_type)
|
|
1430
|
-
erased = elaborated_rbs(ivar_type)
|
|
1956
|
+
def render_attr_rbs_line(method_name, variant, ivar_type, owner = nil)
|
|
1957
|
+
erased = elaborated_rbs(ivar_type, owner: owner)
|
|
1431
1958
|
wrapped = paren_wrap_union(erased)
|
|
1432
1959
|
case variant
|
|
1433
1960
|
when :reader then "def #{method_name}: () -> #{wrapped}"
|
|
@@ -1447,7 +1974,7 @@ module Rigor
|
|
|
1447
1974
|
types = meta_member_types(class_name, layout.member_names)
|
|
1448
1975
|
shape = MetaClassShape.of(
|
|
1449
1976
|
kind: layout.kind, members: layout.member_names, keyword_init: layout.keyword_init,
|
|
1450
|
-
member_types: types.transform_values { |type| paren_wrap_union(union_erase([type])) }
|
|
1977
|
+
member_types: types.transform_values { |type| paren_wrap_union(union_erase([type], owner: class_name)) }
|
|
1451
1978
|
)
|
|
1452
1979
|
shape.member_decls.filter_map do |member|
|
|
1453
1980
|
meta_member_candidate(path, class_name, member, types, scope, environment)
|