@suss/adapter-ruby 0.30.0 → 0.31.0

package/dist/index.d.cts

@@ -635,6 +635,8 @@ declare function createFileCache(parse: (source: string) => Promise<Node>, readF
  * among them, is one of these and can be passed straight through.
  */
 interface BodyReadOptions {
+    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
+    readonly facts?: Database | undefined;
     /** What a pack needs to say a call talks to the database. Absent when no pack does. */
     readonly storage?: RbStorageOptions | undefined;
     /** The methods every pack in the run said its own library defines, which are left off an effect list. */
@@ -652,8 +654,6 @@ interface DiscoveryOptions extends BodyReadOptions {
     absoluteFile?: string;
     /** What a summary's `location.file` says for a file other than the one being read, which a controller's filters need when an ancestor defines them. */
     displayPathOf?: (absolute: string) => string;
-    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
-    facts?: Database;
     cache: FileCache;
     /** Called once per discovered unit whose own body is a method this run can follow calls out of, so the reach walk has a place to start. */
     onReachSeed?: (raw: RawCodeStructure, seed: ReachSeed) => void;
@@ -742,6 +742,11 @@ declare function nodeId(filePath: string, node: Node): string;
  * The key a read of this expression joins on, for a caller that has an
  * expression in hand and wants to ask the rules about it. `enclosing` is
  * the method the expression is written in, or null outside one.
+ *
+ * Two Ruby spellings are keyed on a node rather than on a name. Ruby
+ * gives `receiver.method` no node of its own, so the method name is
+ * where the callee is keyed, and a name Ruby runs as a method is the
+ * call itself.
  */
 declare function readKey(filePath: string, written: Node, enclosing: Node | null): string;
 /**
@@ -856,6 +861,21 @@ interface ExtractRubyResult {
     summaries: BehavioralSummary[];
     facts: Database;
 }
+/** One parsed file and the packs a run over it would load. */
+interface FileFactsOptions {
+    file: string;
+    root: Node;
+    packs: readonly RubyPack[];
+}
+/**
+ * The facts for a single parsed file, with the evaluator bound to them,
+ * for a caller that has one file and no project. A pack's own tests need
+ * these: what built a receiver is an answer the rules give, and without
+ * facts they have nothing to give it from. A project run emits the same
+ * facts across every file at once, so a name written in another file
+ * resolves there and never here.
+ */
+declare function factsForFile(options: FileFactsOptions): Database;
 declare function extractRubyProject(options: ExtractRubyOptions): Promise<ExtractRubyResult>;
 /** Every `.rb` file under `root`, depth-first, skipping the usual non-source directories. */
 declare function findRubyFiles(root: string): string[];
@@ -944,8 +964,12 @@ interface ProjectNodes {
 declare function bindEvaluator(db: Database, nodes: ProjectNodes): void;
 /** Strings to read for the parameters of the block or method `node` is written in, the way a caller would supply them. */
 type ParameterBindings = ReadonlyMap<string, string>;
-/** The abstract value `node` comes down to, through the facts when `db` was bound. */
-declare function evaluatedValue(node: Node, db?: Database, bindings?: ParameterBindings): Value;
+/**
+ * The abstract value `node` comes down to, through the facts when `db`
+ * was bound. With a site, what it comes down to when the receiver
+ * behind it is the instance that site made; that run is not memoized.
+ */
+declare function evaluatedValue(node: Node, db?: Database, bindings?: ParameterBindings, site?: string): Value;
 /** The one string `node` comes down to, or null when it does not settle on one. */
 declare function stringValueOf(node: Node, db?: Database, bindings?: ParameterBindings): string | null;
 /** Every method a file defines, keyed the way the facts key it, for `bindEvaluator`. */
@@ -961,4 +985,4 @@ declare function methodDefinitionsIn(file: string, root: Node): Map<string, Node
  */
 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 EvaluatedFile, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ParameterBindings, type ProjectNodes, type Range, type RbBodyBlock, type RbInflections, type RbStatusCall, 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, nestedStatements, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, 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 FileFactsOptions, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ParameterBindings, type ProjectNodes, type Range, type RbBodyBlock, type RbInflections, type RbStatusCall, 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, factsForFile, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodDefinitionsIn, methodInAncestry, nestedStatements, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };

package/dist/index.d.ts

@@ -635,6 +635,8 @@ declare function createFileCache(parse: (source: string) => Promise<Node>, readF
  * among them, is one of these and can be passed straight through.
  */
 interface BodyReadOptions {
+    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
+    readonly facts?: Database | undefined;
     /** What a pack needs to say a call talks to the database. Absent when no pack does. */
     readonly storage?: RbStorageOptions | undefined;
     /** The methods every pack in the run said its own library defines, which are left off an effect list. */
@@ -652,8 +654,6 @@ interface DiscoveryOptions extends BodyReadOptions {
     absoluteFile?: string;
     /** What a summary's `location.file` says for a file other than the one being read, which a controller's filters need when an ancestor defines them. */
     displayPathOf?: (absolute: string) => string;
-    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
-    facts?: Database;
     cache: FileCache;
     /** Called once per discovered unit whose own body is a method this run can follow calls out of, so the reach walk has a place to start. */
     onReachSeed?: (raw: RawCodeStructure, seed: ReachSeed) => void;
@@ -742,6 +742,11 @@ declare function nodeId(filePath: string, node: Node): string;
  * The key a read of this expression joins on, for a caller that has an
  * expression in hand and wants to ask the rules about it. `enclosing` is
  * the method the expression is written in, or null outside one.
+ *
+ * Two Ruby spellings are keyed on a node rather than on a name. Ruby
+ * gives `receiver.method` no node of its own, so the method name is
+ * where the callee is keyed, and a name Ruby runs as a method is the
+ * call itself.
  */
 declare function readKey(filePath: string, written: Node, enclosing: Node | null): string;
 /**
@@ -856,6 +861,21 @@ interface ExtractRubyResult {
     summaries: BehavioralSummary[];
     facts: Database;
 }
+/** One parsed file and the packs a run over it would load. */
+interface FileFactsOptions {
+    file: string;
+    root: Node;
+    packs: readonly RubyPack[];
+}
+/**
+ * The facts for a single parsed file, with the evaluator bound to them,
+ * for a caller that has one file and no project. A pack's own tests need
+ * these: what built a receiver is an answer the rules give, and without
+ * facts they have nothing to give it from. A project run emits the same
+ * facts across every file at once, so a name written in another file
+ * resolves there and never here.
+ */
+declare function factsForFile(options: FileFactsOptions): Database;
 declare function extractRubyProject(options: ExtractRubyOptions): Promise<ExtractRubyResult>;
 /** Every `.rb` file under `root`, depth-first, skipping the usual non-source directories. */
 declare function findRubyFiles(root: string): string[];
@@ -944,8 +964,12 @@ interface ProjectNodes {
 declare function bindEvaluator(db: Database, nodes: ProjectNodes): void;
 /** Strings to read for the parameters of the block or method `node` is written in, the way a caller would supply them. */
 type ParameterBindings = ReadonlyMap<string, string>;
-/** The abstract value `node` comes down to, through the facts when `db` was bound. */
-declare function evaluatedValue(node: Node, db?: Database, bindings?: ParameterBindings): Value;
+/**
+ * The abstract value `node` comes down to, through the facts when `db`
+ * was bound. With a site, what it comes down to when the receiver
+ * behind it is the instance that site made; that run is not memoized.
+ */
+declare function evaluatedValue(node: Node, db?: Database, bindings?: ParameterBindings, site?: string): Value;
 /** The one string `node` comes down to, or null when it does not settle on one. */
 declare function stringValueOf(node: Node, db?: Database, bindings?: ParameterBindings): string | null;
 /** Every method a file defines, keyed the way the facts key it, for `bindEvaluator`. */
@@ -961,4 +985,4 @@ declare function methodDefinitionsIn(file: string, root: Node): Map<string, Node
  */
 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 EvaluatedFile, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type FileConstants, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ParameterBindings, type ProjectNodes, type Range, type RbBodyBlock, type RbInflections, type RbStatusCall, 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, nestedStatements, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, 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 FileFactsOptions, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ParameterBindings, type ProjectNodes, type Range, type RbBodyBlock, type RbInflections, type RbStatusCall, 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, factsForFile, field, findRubyFiles, graphqlTypeNameFromQualified, hashKeySymbolName, inheritedStatements, methodDefinitionsIn, methodInAncestry, nestedStatements, nodeId, parseRuby, parseRubySync, preloadRubyGrammar, qualifyConstantRef, reachDefinition, readCallArgs, readKey, resolveConstantFile, rubyStubEvidence, runStatements, stringLiteralValue, stringValueOf, symbolValue, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };