spex-parser 0.1.0

package/tests/parser.test.ts

@@ -0,0 +1,227 @@
+import { describe, it, expect } from 'vitest'
+import { SpexParser } from '../src/parser.js'
+import { SpexLexer } from '../src/lexer.js'
+
+const parser = new SpexParser()
+
+function parseInput(text: string) {
+  const lexingResult = SpexLexer.tokenize(text)
+  parser.input = lexingResult.tokens
+  const cst = parser.spexFile() as any
+  return { parser, cst }
+}
+
+describe('SpexParser', () => {
+  describe('object declaration', () => {
+    it('should parse named object declaration', () => {
+      const testCase = 'create MyObject as Number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse product object declaration', () => {
+      const testCase = 'create MyProduct as (n: Number, s: String);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse product object declaration with trailing commas', () => {
+      const testCase = 'create MyProduct as (n: Number, s: String,);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse product object declaration with exponential objects', () => {
+      const testCase = 'create MyProduct as (f: Number -> String, n: Number);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse product object declaration with subobjects', () => {
+      const testCase =
+        'create MyProduct as (p: from Number select { value is positive }, n: Number);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse exponential object declaration with named object', () => {
+      const testCase = 'create MyExponential as Number -> Unit;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse exponential object declaration with product objects', () => {
+      const testCase = 'create MyExponential as (n: Number) -> (s: String);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse exponential object declaration with exponential objects', () => {
+      const testCase = 'create MyExponential as (f: Number -> String, n: Number) -> String;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse exponential object declaration with subobjects', () => {
+      const testCase =
+        'create MyExponential as from Number select { value is positive } -> from Number select { value is positive };'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse subobject declaration with text constraint', () => {
+      const testCase = 'create PositiveNumber as from Number select { are positive };'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse subobject declaration with product objects', () => {
+      const testCase =
+        'create MySubobject as from (n: Number, s: String) select { have a positive @n };'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse subobject declaration with exponential objects', () => {
+      const testCase =
+        'create MySubobject as from (n: Number, s: String) -> Bool select { log the given input };'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse subobject declaration with subobjects', () => {
+      const testCase =
+        'create MySubobject as from from Number select { value is positive } select { value is odd };'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse array type declaration', () => {
+      const testCase = 'create MyArray as string[];'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse array of product type', () => {
+      const testCase = 'create MyArray as (n: Number)[];'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse nested array type', () => {
+      const testCase = 'create MyArray as string[][];'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse object declaration with dotted name', () => {
+      const testCase =
+        'create SignUp as (user: types.EmailAddress, pass: types.Password) -> string;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse basic object string', () => {
+      const testCase = 'create MyObject as string;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse basic object number', () => {
+      const testCase = 'create MyObject as number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse basic object bool', () => {
+      const testCase = 'create MyObject as bool;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse basic object unit', () => {
+      const testCase = 'create MyObject as unit;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse basic objects in product fields', () => {
+      const testCase = 'create Config as (name: string, count: number, active: bool);'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should not allow overriding basic object string', () => {
+      const testCase = 'create string as Number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).not.toHaveLength(0)
+    })
+
+    it('should not allow overriding basic object number', () => {
+      const testCase = 'create number as Number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).not.toHaveLength(0)
+    })
+
+    it('should not allow overriding basic object bool', () => {
+      const testCase = 'create bool as Number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).not.toHaveLength(0)
+    })
+
+    it('should not allow overriding basic object unit', () => {
+      const testCase = 'create unit as Number;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).not.toHaveLength(0)
+    })
+  })
+
+  describe('import declaration', () => {
+    it('should parse named import', () => {
+      const testCase = 'import EmailAddress from "types.spex";'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse named import with alias', () => {
+      const testCase = 'import EmailAddress from "types.spex" as Username;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+
+    it('should parse module import', () => {
+      const testCase = 'import "types.spex" as types;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+  })
+
+  describe('export declaration', () => {
+    it('should parse export declaration', () => {
+      const testCase = 'export EmailAddress;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+  })
+
+  describe('generate declaration', () => {
+    it('should parse generate declaration', () => {
+      const testCase = 'generate Main;'
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+  })
+
+  describe('multiple declarations', () => {
+    it('should parse multiple declarations', () => {
+      const testCase = `
+        create Todo as (id: string, title: string, completed: bool);
+        create EmailAddress as from string select { are email addresses };
+        export EmailAddress;
+        generate Main;
+      `
+      const { parser } = parseInput(testCase)
+      expect(parser.errors).toHaveLength(0)
+    })
+  })
+})

package/tests/props/todo.spex

@@ -0,0 +1,83 @@
+create Todo as (
+  id: string,
+  title: string,
+  description: string,
+  completed: bool,
+  createdAt: string
+);
+
+create TodoTitle as from string select {
+  are not empty and are shorter than 120 characters
+};
+
+create TodoFilePath as from string select {
+  represent a valid path to a JSON file storing todos
+};
+
+create TodoId as from string select {
+  are valid UUIDs
+};
+
+create CliArgs as (
+  command: string,
+  arguments: string[]
+);
+
+create LoadTodos as from (path: TodoFilePath) -> Todo[] select {
+  1. read the JSON file at @path
+  2. return an empty list if the file does not exist
+  3. parse the JSON content into todos
+  4. throw an exception if the JSON is invalid
+};
+
+create SaveTodos as from (path: TodoFilePath, todos: Todo[]) -> unit select {
+  1. serialize @todos as formatted JSON
+  2. write the JSON to @path
+};
+
+create CreateTodo as from (title: TodoTitle) -> Todo select {
+  1. generate a UUID for the todo id
+  2. create a todo with completed set to false
+  3. return the created todo
+};
+
+create AddTodo as from (path: TodoFilePath, title: TodoTitle) -> Todo select {
+  1. call @LoadTodos using @path
+  2. call @CreateTodo using @title
+  3. append the new todo to the loaded todos
+  4. call @SaveTodos to persist the updated todos
+  5. return the created todo
+};
+
+create ListTodos as from (path: TodoFilePath) -> string select {
+  1. load todos using @LoadTodos
+  2. return a formatted string representation of all todos
+  3. show completed todos with a checkmark
+  4. show incomplete todos with an empty checkbox
+};
+
+create CompleteTodo as from (path: TodoFilePath, id: TodoId) -> Todo select {
+  1. load todos using @LoadTodos
+  2. search for the todo matching @id
+  3. throw an exception if the todo does not exist
+  4. set the todo completed status to true
+  5. persist the updated todo list using @SaveTodos
+  6. return the updated todo
+};
+
+create ParseCliArgs as from string[] -> CliArgs select {
+  1. parse the command line arguments
+  2. extract the command name
+  3. extract the command arguments
+};
+
+create Main as from string[] -> unit select {
+  1. parse process arguments using @ParseCliArgs
+  2. if the command is "add": call @AddTodo
+  3. if the command is "list": call @ListTodos and print the result to stdout
+  4. if the command is "complete": call @CompleteTodo
+  5. print a help message if the command is invalid
+  6. print user-friendly error messages for exceptions
+};
+
+generate Main;