Merge pull request #6 from konkerdotdev/basename

Add basename to TInyFileSystem API
konkerdotdev · Jan 31, 2024 · 5f5d144 · 5f5d144
2 parents b9e1dfa + 7f218e9
commit 5f5d144
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 19 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@konker.dev/tiny-filesystem-fp",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "author": "Konrad Markus <mail@konker.dev>",
   "description": "A minimal filesystem abstraction for Node.js and AWS S3, based on Effect-TS",
   "license": "ISC",

diff --git a/src/index.ts b/src/index.ts
@@ -132,6 +132,13 @@ export type TinyFileSystem = {
    */
   fileName: (filePath: string) => P.Effect.Effect<never, TinyFileSystemError, FileName>;
 
+  /**
+   * Extract the last part of a file or directory path
+   *
+   * @param fileOrDirPath - The full path of the file or directory
+   */
+  basename: (fileOrDirPath: string) => Ref;
+
   /**
    * Join the given parts into a full path
    *

diff --git a/src/memfs/index.test.ts b/src/memfs/index.test.ts
@@ -374,6 +374,16 @@ describe('MemFsTinyFileSystem', () => {
     });
   });
 
+  describe('basename', () => {
+    it('should function correctly', () => {
+      expect(memFsTinyFileSystem.basename('foo/bar/baz.json')).toEqual('baz.json');
+      expect(memFsTinyFileSystem.basename('foo/bar')).toEqual('bar');
+      expect(memFsTinyFileSystem.basename('foo/bar/')).toEqual('bar');
+      expect(memFsTinyFileSystem.basename('foo/')).toEqual('foo');
+      expect(memFsTinyFileSystem.basename('foo')).toEqual('foo');
+    });
+  });
+
   describe('extname', () => {
     it('should return the file extension', () => {
       const filePath = '/path/to/file.txt';

diff --git a/src/memfs/index.ts b/src/memfs/index.ts
@@ -145,18 +145,19 @@ function fileName(filePath: string): P.Effect.Effect<never, TinyFileSystemError,
   return P.pipe(
     getFileType(filePath),
     P.Effect.flatMap((fileType) =>
-      P.pipe(
-        fileTypeIsFile(fileType),
-        (isFile) =>
-          isFile
-            ? P.Effect.succeed(path.basename(filePath) as FileName)
-            : P.Effect.fail(toTinyFileSystemError('ERROR MESSAGE'))
-        // FIXME: error message
+      P.pipe(fileTypeIsFile(fileType), (isFile) =>
+        isFile
+          ? P.Effect.succeed(path.basename(filePath) as FileName)
+          : P.Effect.fail(toTinyFileSystemError('Cannot get fileName of a directory'))
       )
     )
   );
 }
 
+function basename(fileOrDirPath: string): Ref {
+  return path.basename(fileOrDirPath) as Ref;
+}
+
 function extname(filePath: string): string {
   return path.extname(filePath);
 }
@@ -185,6 +186,7 @@ export function MemFsTinyFileSystem(fsState: any = {}, cwd = '/'): TinyFileSyste
     relative,
     dirName,
     fileName,
+    basename,
     extname,
   };
 }

diff --git a/src/node/index.test.ts b/src/node/index.test.ts
@@ -352,6 +352,16 @@ describe('NodeTinyFileSystem', () => {
     });
   });
 
+  describe('basename', () => {
+    it('should function correctly', () => {
+      expect(unit.basename('foo/bar/baz.json')).toEqual('baz.json');
+      expect(unit.basename('foo/bar')).toEqual('bar');
+      expect(unit.basename('foo/bar/')).toEqual('bar');
+      expect(unit.basename('foo/')).toEqual('foo');
+      expect(unit.basename('foo')).toEqual('foo');
+    });
+  });
+
   describe('extname', () => {
     it('should return the file extension', () => {
       const filePath = '/path/to/file.txt';

diff --git a/src/node/index.ts b/src/node/index.ts
@@ -132,28 +132,26 @@ function relative(from: string, to: string): Ref {
 }
 
 function dirName(filePath: string): P.Effect.Effect<never, TinyFileSystemError, Ref> {
-  return P.pipe(
-    getFileType(filePath),
-    P.Effect.map((_) => path.dirname(filePath) as DirectoryPath)
-  );
+  return P.Effect.succeed(path.dirname(filePath) as DirectoryPath);
 }
 
 function fileName(filePath: string): P.Effect.Effect<never, TinyFileSystemError, FileName> {
   return P.pipe(
     getFileType(filePath),
     P.Effect.flatMap((fileType) =>
-      P.pipe(
-        fileTypeIsFile(fileType),
-        (isFile) =>
-          isFile
-            ? P.Effect.succeed(path.basename(filePath) as FileName)
-            : P.Effect.fail(toTinyFileSystemError('ERROR MESSAGE'))
-        // FIXME: error message
+      P.pipe(fileTypeIsFile(fileType), (isFile) =>
+        isFile
+          ? P.Effect.succeed(path.basename(filePath) as FileName)
+          : P.Effect.fail(toTinyFileSystemError('Cannot get file name of a directory'))
       )
     )
   );
 }
 
+function basename(fileOrDirPath: string): Ref {
+  return path.basename(fileOrDirPath) as Ref;
+}
+
 function extname(filePath: string): string {
   return path.extname(filePath);
 }
@@ -178,5 +176,6 @@ export const NodeTinyFileSystem: TinyFileSystemWithGlob<TinyFileSystemAppendable
   relative,
   dirName,
   fileName,
+  basename,
   extname,
 };
diff --git a/src/s3/index.test.ts b/src/s3/index.test.ts
@@ -509,6 +509,16 @@ describe('S3TinyFileSystem', () => {
     });
   });
 
+  describe('basename', () => {
+    it('should function correctly', () => {
+      expect(s3TinyFileSystem.basename('s3://foo/bar/baz.json')).toEqual('baz.json');
+      expect(s3TinyFileSystem.basename('s3://foo/bar')).toEqual('bar');
+      expect(s3TinyFileSystem.basename('s3://foo/bar/')).toEqual('bar');
+      expect(s3TinyFileSystem.basename('s3://foo/')).toEqual('foo');
+      expect(s3TinyFileSystem.basename('s3://foo')).toEqual('foo');
+    });
+  });
+
   describe('relative', () => {
     it('should function correctly', async () => {
       expect(s3TinyFileSystem.relative('s3://foo/bar/', 's3://foo/bar/baz/qux.json')).toBe('baz/qux.json');

diff --git a/src/s3/index.ts b/src/s3/index.ts
@@ -314,6 +314,10 @@ function fileName(filePath: string): P.Effect.Effect<never, TinyFileSystemError,
   );
 }
 
+function basename(fileOrDirPath: string): Ref {
+  return path.posix.basename(fileOrDirPath) as Ref;
+}
+
 function extname(filePath: string): string {
   return path.posix.extname(filePath);
 }
@@ -331,6 +335,7 @@ export const S3TinyFileSystem = (config: S3ClientConfig): P.Effect.Effect<S3Fact
         relative,
         dirName,
         fileName,
+        basename,
         extname,
 
         getFileReadStream: getFileReadStream(s3Client),