@suss/adapter-ruby 0.22.1 → 0.22.2

package/dist/index.d.cts

@@ -4,6 +4,7 @@ import { Database } from '@suss/datalog';
 import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
 import { RawCodeStructure, TimingReport, ExtractionReport, CacheDiagnostic } from '@suss/extractor';
 import { WhyExplained } from '@suss/resolution';
+import { Value } from '@suss/values';
 
 /**
  * A new `Parser` for every call, so that parses running at the same time do
@@ -563,6 +564,37 @@ interface TypeReadContext {
  */
 declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape | null;
 
+/**
+ * One evaluator per project, over the parsed files and the resolution
+ * facts. A reader hands in a node and gets back the abstract value it
+ * comes down to; a route path or a prefix is then spelled from that
+ * value rather than read off one syntax shape.
+ *
+ * The facts key a node by file and span, so the evaluator keeps every
+ * file's root to find the node a fact refers to. Without facts,
+ * which is how a unit test or a routes file on its own runs, the
+ * evaluator still follows names within the file through the engine's
+ * own scope walk.
+ */
+
+interface EvaluatedFile {
+    readonly file: string;
+    readonly root: Node;
+}
+interface ProjectNodes {
+    readonly files: readonly EvaluatedFile[];
+    /** Every method definition by its node key, for a resolved callee. */
+    readonly definitions: ReadonlyMap<string, Node>;
+}
+/** Register the parsed project, so reads through `db` can follow the facts back to nodes. */
+declare function bindEvaluator(db: Database, nodes: ProjectNodes): void;
+/** The abstract value `node` comes down to, through the facts when `db` was bound. */
+declare function evaluatedValue(node: Node, db?: Database): Value;
+/** The one string `node` comes down to, or null when it does not settle on one. */
+declare function stringValueOf(node: Node, db?: Database): string | null;
+/** Every method a file defines, keyed the way the facts key it, for `bindEvaluator`. */
+declare function methodDefinitionsIn(file: string, root: Node): Map<string, Node>;
+
 /**
  * version.ts: this adapter's own half of the cache key.
  *
@@ -573,4 +605,4 @@ declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape
  */
 declare const ADAPTER_VERSION = "0.1.0";
 
-export { ADAPTER_VERSION, type AncestorEntry, type AncestorLookup, type Ancestry, type CallArgs, type ClassInfo, type ConstantPathConvention, type ControllerActions, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type Range, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyExtendsSite, type RubyPack, type RubyRequireSite, type RubyStubEvidence, type RubyStubEvidenceOptions, type RubyValueHandle, RubyWhySession, type RubyWhySessionOptions, type TypeReadContext, ancestryOf, bodyStatements, booleanLiteralValue, collectFileConstants, createFileCache, discoverUnits, emitConstantBindings, emitEntryFact, emitValueFacts, extractRubyProject, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodInAncestry, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };
+export { ADAPTER_VERSION, type AncestorEntry, type AncestorLookup, type Ancestry, type CallArgs, type ClassInfo, type ConstantPathConvention, type ControllerActions, type DiscoveryOptions, type EvaluatedFile, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ProjectNodes, type Range, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyExtendsSite, type RubyPack, type RubyRequireSite, type RubyStubEvidence, type RubyStubEvidenceOptions, type RubyValueHandle, RubyWhySession, type RubyWhySessionOptions, type TypeReadContext, ancestryOf, bindEvaluator, bodyStatements, booleanLiteralValue, collectFileConstants, createFileCache, discoverUnits, emitConstantBindings, emitEntryFact, emitValueFacts, evaluatedValue, extractRubyProject, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodDefinitionsIn, methodInAncestry, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { Database } from '@suss/datalog';
 import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
 import { RawCodeStructure, TimingReport, ExtractionReport, CacheDiagnostic } from '@suss/extractor';
 import { WhyExplained } from '@suss/resolution';
+import { Value } from '@suss/values';
 
 /**
  * A new `Parser` for every call, so that parses running at the same time do
@@ -563,6 +564,37 @@ interface TypeReadContext {
  */
 declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape | null;
 
+/**
+ * One evaluator per project, over the parsed files and the resolution
+ * facts. A reader hands in a node and gets back the abstract value it
+ * comes down to; a route path or a prefix is then spelled from that
+ * value rather than read off one syntax shape.
+ *
+ * The facts key a node by file and span, so the evaluator keeps every
+ * file's root to find the node a fact refers to. Without facts,
+ * which is how a unit test or a routes file on its own runs, the
+ * evaluator still follows names within the file through the engine's
+ * own scope walk.
+ */
+
+interface EvaluatedFile {
+    readonly file: string;
+    readonly root: Node;
+}
+interface ProjectNodes {
+    readonly files: readonly EvaluatedFile[];
+    /** Every method definition by its node key, for a resolved callee. */
+    readonly definitions: ReadonlyMap<string, Node>;
+}
+/** Register the parsed project, so reads through `db` can follow the facts back to nodes. */
+declare function bindEvaluator(db: Database, nodes: ProjectNodes): void;
+/** The abstract value `node` comes down to, through the facts when `db` was bound. */
+declare function evaluatedValue(node: Node, db?: Database): Value;
+/** The one string `node` comes down to, or null when it does not settle on one. */
+declare function stringValueOf(node: Node, db?: Database): string | null;
+/** Every method a file defines, keyed the way the facts key it, for `bindEvaluator`. */
+declare function methodDefinitionsIn(file: string, root: Node): Map<string, Node>;
+
 /**
  * version.ts: this adapter's own half of the cache key.
  *
@@ -573,4 +605,4 @@ declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape
  */
 declare const ADAPTER_VERSION = "0.1.0";
 
-export { ADAPTER_VERSION, type AncestorEntry, type AncestorLookup, type Ancestry, type CallArgs, type ClassInfo, type ConstantPathConvention, type ControllerActions, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type Range, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyExtendsSite, type RubyPack, type RubyRequireSite, type RubyStubEvidence, type RubyStubEvidenceOptions, type RubyValueHandle, RubyWhySession, type RubyWhySessionOptions, type TypeReadContext, ancestryOf, bodyStatements, booleanLiteralValue, collectFileConstants, createFileCache, discoverUnits, emitConstantBindings, emitEntryFact, emitValueFacts, extractRubyProject, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodInAncestry, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };
+export { ADAPTER_VERSION, type AncestorEntry, type AncestorLookup, type Ancestry, type CallArgs, type ClassInfo, type ConstantPathConvention, type ControllerActions, type DiscoveryOptions, type EvaluatedFile, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ProjectNodes, type Range, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyExtendsSite, type RubyPack, type RubyRequireSite, type RubyStubEvidence, type RubyStubEvidenceOptions, type RubyValueHandle, RubyWhySession, type RubyWhySessionOptions, type TypeReadContext, ancestryOf, bindEvaluator, bodyStatements, booleanLiteralValue, collectFileConstants, createFileCache, discoverUnits, emitConstantBindings, emitEntryFact, emitValueFacts, evaluatedValue, extractRubyProject, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodDefinitionsIn, methodInAncestry, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };