@suss/adapter-ruby 0.3.2-0 → 0.5.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import { Tree, Node } from 'web-tree-sitter';
 export { Node as RbNode, Tree as RbTree } from 'web-tree-sitter';
-import { RawCodeStructure } from '@suss/extractor';
-import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
 import { Database } from '@suss/datalog';
+import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
+import { RawCodeStructure } from '@suss/extractor';
 
 /**
  * Finds the file behind a constant.
@@ -147,6 +147,21 @@ interface RubyPack {
     /** Wire protocol for the produced boundary bindings, e.g. "http-graphql". */
     protocol: string;
     discovery: RubyDiscoveryPattern[];
+    /** What the library's own database calls look like. The README says how one is matched. */
+    storage?: RbStoragePattern[];
+}
+/**
+ * Ruby writes no return type, so a call is matched by what its receiver
+ * inherits from. A model is a class that reaches one of these base classes,
+ * whether the project declares an intermediate one or not.
+ */
+interface RbStoragePattern {
+    /** Base classes the library gives a model, `ActiveRecord::Base` for Rails. */
+    baseClasses: string[];
+    /** Methods that change what is stored. Anything else reads. */
+    writes: string[];
+    /** Which database is behind the connection, which the project settles. */
+    storageSystem: "postgres" | "mysql" | "sqlite";
 }
 type RubyDiscoveryPattern = GraphqlObjectFields;
 /** A class whose `< ...` superclass is one of `baseClassNames` declares GraphQL fields through DSL calls in its own body. */
@@ -183,6 +198,11 @@ interface GraphqlObjectFields {
     typeNameConvention: GraphqlTypeNameConvention;
 }
 
+interface RbStorageOptions {
+    readonly facts: Database;
+    readonly patterns: readonly RbStoragePattern[];
+}
+
 /** Parsed files by absolute path, so a class that several fields refer to is only parsed once. */
 interface FileCache {
     get(absPath: string): Promise<Node | null>;
@@ -193,6 +213,8 @@ interface DiscoveryOptions {
     /** Repo-relative or absolute path recorded on each summary's `location.file`. */
     filePath: string;
     cache: FileCache;
+    /** What a pack needs to say a call talks to the database. Absent when no pack does. */
+    storage?: RbStorageOptions | undefined;
 }
 declare function discoverUnits(root: Node, options: DiscoveryOptions): Promise<RawCodeStructure[]>;
 
@@ -253,4 +275,4 @@ interface TypeReadContext {
  */
 declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape | null;
 
-export { type AncestorEntry, type AncestorLookup, type Ancestry, type ClassInfo, type ConstantPathConvention, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ReachedBody, type RubyDiscoveryPattern, type RubyPack, type TypeReadContext, ancestryOf, createFileCache, discoverUnits, emitEntryFact, extractRubyProject, findRubyFiles, graphqlTypeNameFromQualified, inheritedStatements, methodInAncestry, parseRuby, qualifyConstantRef, reachDefinition, resolveConstantFile, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };
+export { type AncestorEntry, type AncestorLookup, type Ancestry, type ClassInfo, type ConstantPathConvention, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyPack, type TypeReadContext, ancestryOf, createFileCache, discoverUnits, emitEntryFact, extractRubyProject, findRubyFiles, graphqlTypeNameFromQualified, inheritedStatements, methodInAncestry, parseRuby, qualifyConstantRef, reachDefinition, resolveConstantFile, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { Tree, Node } from 'web-tree-sitter';
 export { Node as RbNode, Tree as RbTree } from 'web-tree-sitter';
-import { RawCodeStructure } from '@suss/extractor';
-import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
 import { Database } from '@suss/datalog';
+import { TypeShape, BehavioralSummary } from '@suss/behavioral-ir';
+import { RawCodeStructure } from '@suss/extractor';
 
 /**
  * Finds the file behind a constant.
@@ -147,6 +147,21 @@ interface RubyPack {
     /** Wire protocol for the produced boundary bindings, e.g. "http-graphql". */
     protocol: string;
     discovery: RubyDiscoveryPattern[];
+    /** What the library's own database calls look like. The README says how one is matched. */
+    storage?: RbStoragePattern[];
+}
+/**
+ * Ruby writes no return type, so a call is matched by what its receiver
+ * inherits from. A model is a class that reaches one of these base classes,
+ * whether the project declares an intermediate one or not.
+ */
+interface RbStoragePattern {
+    /** Base classes the library gives a model, `ActiveRecord::Base` for Rails. */
+    baseClasses: string[];
+    /** Methods that change what is stored. Anything else reads. */
+    writes: string[];
+    /** Which database is behind the connection, which the project settles. */
+    storageSystem: "postgres" | "mysql" | "sqlite";
 }
 type RubyDiscoveryPattern = GraphqlObjectFields;
 /** A class whose `< ...` superclass is one of `baseClassNames` declares GraphQL fields through DSL calls in its own body. */
@@ -183,6 +198,11 @@ interface GraphqlObjectFields {
     typeNameConvention: GraphqlTypeNameConvention;
 }
 
+interface RbStorageOptions {
+    readonly facts: Database;
+    readonly patterns: readonly RbStoragePattern[];
+}
+
 /** Parsed files by absolute path, so a class that several fields refer to is only parsed once. */
 interface FileCache {
     get(absPath: string): Promise<Node | null>;
@@ -193,6 +213,8 @@ interface DiscoveryOptions {
     /** Repo-relative or absolute path recorded on each summary's `location.file`. */
     filePath: string;
     cache: FileCache;
+    /** What a pack needs to say a call talks to the database. Absent when no pack does. */
+    storage?: RbStorageOptions | undefined;
 }
 declare function discoverUnits(root: Node, options: DiscoveryOptions): Promise<RawCodeStructure[]>;
 
@@ -253,4 +275,4 @@ interface TypeReadContext {
  */
 declare function typeShapeFromNode(node: Node, ctx: TypeReadContext): TypeShape | null;
 
-export { type AncestorEntry, type AncestorLookup, type Ancestry, type ClassInfo, type ConstantPathConvention, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type ReachedBody, type RubyDiscoveryPattern, type RubyPack, type TypeReadContext, ancestryOf, createFileCache, discoverUnits, emitEntryFact, extractRubyProject, findRubyFiles, graphqlTypeNameFromQualified, inheritedStatements, methodInAncestry, parseRuby, qualifyConstantRef, reachDefinition, resolveConstantFile, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };
+export { type AncestorEntry, type AncestorLookup, type Ancestry, type ClassInfo, type ConstantPathConvention, type DiscoveryOptions, type ExtractRubyOptions, type ExtractRubyResult, type FileCache, type GraphqlObjectFields, type GraphqlTypeNameConvention, type MethodLookup, type RbStoragePattern, type ReachedBody, type RubyDiscoveryPattern, type RubyPack, type TypeReadContext, ancestryOf, createFileCache, discoverUnits, emitEntryFact, extractRubyProject, findRubyFiles, graphqlTypeNameFromQualified, inheritedStatements, methodInAncestry, parseRuby, qualifyConstantRef, reachDefinition, resolveConstantFile, typeShapeFromNode, underscoreConstantPath, unitKey, walkClasses, walkDefinitions };