Merge pull request #25 from sonicbaume/file-adapter

File IO using adapter

Author: willwade

.gitignore

@@ -186,3 +186,6 @@ examples/gemini_response.txt
 aac-metrics/
 compare-effort-scores.ts
 .DS_Store
+
+# Watchman config (for dev env)
+.watchmanconfig

package-lock.json

@@ -10,17 +10,15 @@ import {
 } from '../utilities/analytics/history';
 import { ComparisonAnalyzer, MetricsCalculator } from '../utilities/analytics';
 import { CellScanningOrder, ScanningSelectionMethod } from '../types/aac';
-import path from 'path';
-import fs from 'fs';
+import { defaultFileAdapter, extname } from '../utils/io';
+
+const { pathExists, isDirectory, join, readTextFromInput, basename, writeTextToPath } =
+  defaultFileAdapter;
 
 // Helper function to detect format from file/folder path
 function detectFormat(filePath: string): string {
   // Check if it's a folder ending with .ascconfig
-  if (
-    fs.existsSync(filePath) &&
-    fs.statSync(filePath).isDirectory() &&
-    filePath.endsWith('.ascconfig')
-  ) {
+  if (pathExists(filePath) && isDirectory(filePath) && filePath.endsWith('.ascconfig')) {
     return 'ascconfig';
   }
 
@@ -33,7 +31,7 @@ function detectFormat(filePath: string): string {
   }
 
   // Otherwise use file extension
-  return path.extname(filePath).slice(1);
+  return extname(filePath).slice(1);
 }
 
 // Helper function to parse filtering options from CLI arguments
@@ -86,9 +84,9 @@ function parseFilteringOptions(options: {
 }
 
 // Set version from package.json
-const packageJson = JSON.parse(
-  fs.readFileSync(path.join(__dirname, '../../package.json'), 'utf8')
-) as { version: string };
+const packageJson = JSON.parse(readTextFromInput(join(__dirname, '../../package.json'))) as {
+  version: string;
+};
 program.version(packageJson.version);
 
 program
@@ -403,14 +401,13 @@ program
       }
     ) => {
       try {
-        if (!fs.existsSync(input)) {
+        if (!pathExists(input)) {
           throw new Error(`File not found: ${input}`);
         }
 
         const normalizedSource = (options.source || 'auto').toLowerCase();
-        const ext = path.extname(input).toLowerCase();
-        const isGrid3Db =
-          ext === '.sqlite' || path.basename(input).toLowerCase() === 'history.sqlite';
+        const ext = extname(input).toLowerCase();
+        const isGrid3Db = ext === '.sqlite' || basename(input).toLowerCase() === 'history.sqlite';
         const isSnap = ext === '.sps' || ext === '.spb';
 
         let entries;
@@ -438,7 +435,7 @@ program
 
         const output = JSON.stringify(payload, null, 2);
         if (options.out) {
-          fs.writeFileSync(options.out, output);
+          writeTextToPath(options.out, output);
         } else {
           console.log(output);
         }
@@ -578,7 +575,7 @@ program
 
         const output = options.pretty ? JSON.stringify(result, null, 2) : JSON.stringify(result);
         if (options.out) {
-          fs.writeFileSync(options.out, output);
+          writeTextToPath(options.out, output);
         } else {
           console.log(output);
         }

src/cli/index.ts

@@ -43,7 +43,7 @@
 import { AACTree, AACButton, AACSemanticCategory } from './treeStructure';
 import { StringCasing, detectCasing, isNumericOrEmpty } from './stringCasing';
 import { ValidationResult } from '../validation/validationTypes';
-import { BinaryOutput, ProcessorInput } from '../utils/io';
+import { BinaryOutput, defaultFileAdapter, FileAdapter, ProcessorInput } from '../utils/io';
 import { getZipAdapter, ZipAdapter } from '../utils/zip';
 
 // Configuration options for processors
@@ -73,6 +73,9 @@ export interface ProcessorConfig {
   // Defaults to 'en-GB' if not specified
   grid3Locale?: string;
 
+  // Adapter for reading/writing files
+  fileAdapter: FileAdapter;
+
   // Adapter for handling encoding/decoding zip files
   zipAdapter: (input?: ProcessorInput) => Promise<ZipAdapter>;
 }
@@ -126,6 +129,7 @@ abstract class BaseProcessor {
       excludeNavigationButtons: true,
       excludeSystemButtons: true,
       preserveAllButtons: false,
+      fileAdapter: defaultFileAdapter,
       zipAdapter: getZipAdapter,
       ...options,
     };

src/core/baseProcessor.ts

@@ -13,21 +13,12 @@ import {
   AACSemanticCategory,
   AACSemanticIntent,
 } from '../core/treeStructure';
-// Removed unused import: FileProcessor
 import plist, { PlistValue } from 'plist';
 import {
   ValidationFailureError,
   buildValidationResultFromMessage,
 } from '../validation/validationTypes';
-import {
-  ProcessorInput,
-  getBasename,
-  getFs,
-  getPath,
-  readBinaryFromInput,
-  readTextFromInput,
-  writeTextToPath,
-} from '../utils/io';
+import { ProcessorInput, getBasename } from '../utils/io';
 
 interface ApplePanelsActionParameters {
   CharString?: string;
@@ -227,24 +218,24 @@ class ApplePanelsProcessor extends BaseProcessor {
   }
 
   async loadIntoTree(filePathOrBuffer: ProcessorInput): Promise<AACTree> {
+    const { readBinaryFromInput, readTextFromInput, pathExists, getFileSize, join } =
+      this.options.fileAdapter;
     await Promise.resolve();
     const filename =
       typeof filePathOrBuffer === 'string' ? getBasename(filePathOrBuffer) : 'upload.plist';
     let buffer: Uint8Array;
 
     try {
       if (typeof filePathOrBuffer === 'string') {
-        const fs = getFs();
-        const path = getPath();
         if (filePathOrBuffer.endsWith('.ascconfig')) {
-          const panelDefsPath = path.join(
+          const panelDefsPath = join(
             filePathOrBuffer,
             'Contents',
             'Resources',
             'PanelDefinitions.plist'
           );
-          if (fs.existsSync(panelDefsPath)) {
-            buffer = fs.readFileSync(panelDefsPath);
+          if (pathExists(panelDefsPath)) {
+            buffer = readBinaryFromInput(panelDefsPath);
           } else {
             const validation = buildValidationResultFromMessage({
               filename,
@@ -257,7 +248,7 @@ class ApplePanelsProcessor extends BaseProcessor {
             throw new ValidationFailureError('Apple Panels file not found', validation);
           }
         } else {
-          buffer = fs.readFileSync(filePathOrBuffer);
+          buffer = readBinaryFromInput(filePathOrBuffer);
         }
       } else {
         buffer = readBinaryFromInput(filePathOrBuffer);
@@ -403,8 +394,7 @@ class ApplePanelsProcessor extends BaseProcessor {
         filesize:
           typeof filePathOrBuffer === 'string'
             ? (() => {
-                const fs = getFs();
-                return fs.existsSync(filePathOrBuffer) ? fs.statSync(filePathOrBuffer).size : 0;
+                return pathExists(filePathOrBuffer) ? getFileSize(filePathOrBuffer) : 0;
               })()
             : readBinaryFromInput(filePathOrBuffer).byteLength,
         format: 'applepanels',
@@ -421,6 +411,7 @@ class ApplePanelsProcessor extends BaseProcessor {
     translations: Map<string, string>,
     outputPath: string
   ): Promise<Uint8Array> {
+    const { readBinaryFromInput, join } = this.options.fileAdapter;
     // Load the tree, apply translations, and save to new file
     const tree = await this.loadIntoTree(filePathOrBuffer);
 
@@ -477,13 +468,13 @@ class ApplePanelsProcessor extends BaseProcessor {
     if (outputPath.endsWith('.plist')) {
       return readBinaryFromInput(outputPath);
     }
-    const path = getPath();
     const configPath = outputPath.endsWith('.ascconfig') ? outputPath : `${outputPath}.ascconfig`;
-    const panelDefsPath = path.join(configPath, 'Contents', 'Resources', 'PanelDefinitions.plist');
+    const panelDefsPath = join(configPath, 'Contents', 'Resources', 'PanelDefinitions.plist');
     return readBinaryFromInput(panelDefsPath);
   }
 
   async saveFromTree(tree: AACTree, outputPath: string): Promise<void> {
+    const { writeTextToPath, pathExists, mkDir, join, dirname } = this.options.fileAdapter;
     await Promise.resolve();
     // Support two output modes:
     // 1) Single-file .plist (PanelDefinitions.plist content written directly)
@@ -495,15 +486,13 @@ class ApplePanelsProcessor extends BaseProcessor {
     let contentsPath = '';
     let resourcesPath = '';
     if (!isSinglePlist) {
-      const fs = getFs();
-      const path = getPath();
       configPath = outputPath.endsWith('.ascconfig') ? outputPath : `${outputPath}.ascconfig`;
-      contentsPath = path.join(configPath, 'Contents');
-      resourcesPath = path.join(contentsPath, 'Resources');
+      contentsPath = join(configPath, 'Contents');
+      resourcesPath = join(contentsPath, 'Resources');
 
-      if (!fs.existsSync(configPath)) fs.mkdirSync(configPath, { recursive: true });
-      if (!fs.existsSync(contentsPath)) fs.mkdirSync(contentsPath, { recursive: true });
-      if (!fs.existsSync(resourcesPath)) fs.mkdirSync(resourcesPath, { recursive: true });
+      if (!pathExists(configPath)) mkDir(configPath, { recursive: true });
+      if (!pathExists(contentsPath)) mkDir(contentsPath, { recursive: true });
+      if (!pathExists(resourcesPath)) mkDir(resourcesPath, { recursive: true });
 
       // Create Info.plist (bundle mode only)
       const infoPlist = {
@@ -521,11 +510,11 @@ class ApplePanelsProcessor extends BaseProcessor {
           `Generated by AAC Processors${tree.metadata?.author ? ` - Author: ${tree.metadata.author}` : ''}`,
       };
       const infoPlistContent = plist.build(infoPlist);
-      writeTextToPath(path.join(contentsPath, 'Info.plist'), infoPlistContent);
+      writeTextToPath(join(contentsPath, 'Info.plist'), infoPlistContent);
 
       // Create AssetIndex.plist (empty)
       const assetIndexContent = plist.build({});
-      writeTextToPath(path.join(resourcesPath, 'AssetIndex.plist'), assetIndexContent);
+      writeTextToPath(join(resourcesPath, 'AssetIndex.plist'), assetIndexContent);
     }
 
     // Build PanelDefinitions content from tree
@@ -666,15 +655,12 @@ class ApplePanelsProcessor extends BaseProcessor {
 
     if (isSinglePlist) {
       // Write single PanelDefinitions.plist file directly
-      const fs = getFs();
-      const path = getPath();
-      const dir = path.dirname(outputPath);
-      if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+      const dir = dirname(outputPath);
+      if (!pathExists(dir)) mkDir(dir, { recursive: true });
       writeTextToPath(outputPath, panelDefsContent);
     } else {
       // Write into bundle structure
-      const path = getPath();
-      writeTextToPath(path.join(resourcesPath, 'PanelDefinitions.plist'), panelDefsContent);
+      writeTextToPath(join(resourcesPath, 'PanelDefinitions.plist'), panelDefsContent);
     }
   }