Rename project from Squongo to QueryLeaf

Author: rathboma

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run Tests
+name: QueryLeaf Tests
 
 on:
   push:

README.md

@@ -1,10 +1,10 @@
-# Squongo
+# QueryLeaf
 
-SQL to MongoDB command compiler for NodeJS.
+SQL to MongoDB query translator for NodeJS.
 
 ## Overview
 
-Squongo is a library that translates SQL queries into MongoDB commands. It parses SQL using node-sql-parser, transforms it into an abstract command set, and then executes those commands against the MongoDB Node.js driver.
+QueryLeaf is a library that translates SQL queries into MongoDB commands. It parses SQL using node-sql-parser, transforms it into an abstract command set, and then executes those commands against the MongoDB Node.js driver.
 
 ## Features
 
@@ -25,35 +25,35 @@ Squongo is a library that translates SQL queries into MongoDB commands. It parse
 ## Installation
 
 ```bash
-npm install squongo
+npm install queryleaf
 ```
 
 ## Usage
 
 ```typescript
-import { createSquongo } from 'squongo';
+import { createQueryLeaf } from 'queryleaf';
 
 async function main() {
-  // Create a Squongo instance
-  const squongo = createSquongo('mongodb://localhost:27017', 'mydatabase');
+  // Create a QueryLeaf instance
+  const queryLeaf = createQueryLeaf('mongodb://localhost:27017', 'mydatabase');
 
   try {
     // Basic SQL query
-    const basicResults = await squongo.execute('SELECT * FROM users WHERE age > 21');
+    const basicResults = await queryLeaf.execute('SELECT * FROM users WHERE age > 21');
     console.log('Basic query results:', basicResults);
 
     // Query with nested fields
-    const nestedResults = await squongo.execute('SELECT name, address.city, address.zip FROM users WHERE address.country = "USA"');
+    const nestedResults = await queryLeaf.execute('SELECT name, address.city, address.zip FROM users WHERE address.country = "USA"');
     console.log('Nested fields query results:', nestedResults);
 
     // Query with array access
-    const arrayResults = await squongo.execute('SELECT order_id, items[0].name, items[0].price FROM orders WHERE items[0].price > 100');
+    const arrayResults = await queryLeaf.execute('SELECT order_id, items[0].name, items[0].price FROM orders WHERE items[0].price > 100');
     console.log('Array access query results:', arrayResults);
   } catch (error) {
     console.error('Error executing query:', error);
   } finally {
     // Close the MongoDB connection when done
-    await squongo.close();
+    await queryLeaf.close();
   }
 }
 

TODO.md

@@ -1,4 +1,4 @@
-# Squongo Project TODO List
+# QueryLeaf Project TODO List
 
 ## Integration Tests to Add
 

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "squongo",
+  "name": "queryleaf",
   "version": "0.1.0",
-  "description": "SQL to MongoDB command compiler",
+  "description": "SQL to MongoDB query translator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -21,6 +21,14 @@
   ],
   "author": "",
   "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beekeeper-studio/queryleaf.git"
+  },
+  "bugs": {
+    "url": "https://github.com/beekeeper-studio/queryleaf/issues"
+  },
+  "homepage": "https://github.com/beekeeper-studio/queryleaf#readme",
   "dependencies": {
     "mongodb": "^6.14.2",
     "node-sql-parser": "^4.11.0"

src/__tests__/integration/test-setup.ts

@@ -1,13 +1,13 @@
 import { MongoTestContainer, loadFixtures, testUsers, testProducts, testOrders } from '../utils/mongo-container';
-import { createSquongo } from '../../index';
+import { createQueryLeaf } from '../../index';
 import { Db } from 'mongodb';
 
 /**
  * Base test setup for integration tests
  */
 export class IntegrationTestSetup {
   public mongoContainer: MongoTestContainer;
-  public TEST_DB = 'squongo_test';
+  public TEST_DB = 'queryleaf_test';
   public connectionString: string = '';
 
   constructor() {
@@ -43,10 +43,10 @@ export class IntegrationTestSetup {
   }
 
   /**
-   * Create a new Squongo instance
+   * Create a new QueryLeaf instance
    */
   getSquongo() {
-    return createSquongo(this.connectionString, this.TEST_DB);
+    return createQueryLeaf(this.connectionString, this.TEST_DB);
   }
 }
 

src/examples/basic-usage.ts

@@ -1,21 +1,21 @@
-import { createSquongo } from '../index';
+import { createQueryLeaf } from '../index';
 
 /**
- * Example showing basic usage of Squongo
+ * Example showing basic usage of QueryLeaf
  */
 async function main() {
   // Connection info for MongoDB
   const connectionString = 'mongodb://localhost:27017';
   const dbName = 'example';
 
-  // Create a Squongo instance
-  const squongo = createSquongo(connectionString, dbName);
+  // Create a QueryLeaf instance
+  const queryLeaf = createQueryLeaf(connectionString, dbName);
 
   try {
     // Setup sample data with nested structures and arrays
     console.log('\nSetting up sample data with nested structures and arrays...');
 
-    await squongo.execute(`
+    await queryLeaf.execute(`
       INSERT INTO users (_id, name, age, email, active, address) VALUES 
       ('101', 'Nested User', 30, '[email protected]', true, {
         "street": "123 Main St",
@@ -25,7 +25,7 @@ async function main() {
       })
     `);
 
-    await squongo.execute(`
+    await queryLeaf.execute(`
       INSERT INTO orders (_id, userId, items, total) VALUES 
       ('201', '101', [
         { "id": "item1", "name": "Laptop", "price": 1200 },
@@ -89,15 +89,15 @@ async function main() {
     for (const sql of queries) {
       console.log(`\nExecuting SQL: ${sql}`);
       try {
-        const result = await squongo.execute(sql);
+        const result = await queryLeaf.execute(sql);
         console.log('Result:', JSON.stringify(result, null, 2));
       } catch (error) {
         console.error('Error:', error instanceof Error ? error.message : String(error));
       }
     }
   } finally {
     // Close the MongoDB connection when done
-    await squongo.close();
+    await queryLeaf.close();
   }
 }
 

src/index.ts

@@ -4,22 +4,22 @@ import {
   SqlParser, 
   SqlCompiler, 
   CommandExecutor,
-  Squongo
+  Squongo as QueryLeaf
 } from './interfaces';
 import { SqlParserImpl } from './parser';
 import { SqlCompilerImpl } from './compiler';
 import { MongoExecutor } from './executor';
 
 /**
- * Squongo implementation
+ * QueryLeaf implementation
  */
-class SquongoImpl implements Squongo {
+class QueryLeafImpl implements QueryLeaf {
   private parser: SqlParser;
   private compiler: SqlCompiler;
   private executor: CommandExecutor;
 
   /**
-   * Create a new Squongo instance
+   * Create a new QueryLeaf instance
    * @param parser SQL parser
    * @param compiler SQL compiler
    * @param executor Command executor
@@ -76,17 +76,29 @@ class SquongoImpl implements Squongo {
 }
 
 /**
- * Create a new Squongo instance
+ * Create a new QueryLeaf instance
  * @param connectionString MongoDB connection string
  * @param dbName Database name
- * @returns Squongo instance
+ * @returns QueryLeaf instance
  */
-export function createSquongo(connectionString: string, dbName: string): Squongo {
+export function createQueryLeaf(connectionString: string, dbName: string): QueryLeaf {
   const parser = new SqlParserImpl();
   const compiler = new SqlCompilerImpl();
   const executor = new MongoExecutor(connectionString, dbName);
 
-  return new SquongoImpl(parser, compiler, executor);
+  return new QueryLeafImpl(parser, compiler, executor);
+}
+
+/**
+ * Create a new Squongo instance - alias for createQueryLeaf for backwards compatibility
+ * @deprecated Use createQueryLeaf instead
+ * @param connectionString MongoDB connection string
+ * @param dbName Database name
+ * @returns QueryLeaf instance
+ */
+export function createSquongo(connectionString: string, dbName: string): QueryLeaf {
+  console.warn("Warning: createSquongo is deprecated, use createQueryLeaf instead");
+  return createQueryLeaf(connectionString, dbName);
 }
 
 // Export interfaces and implementation classes
@@ -96,11 +108,12 @@ export {
   SqlParser,
   SqlCompiler,
   CommandExecutor,
-  Squongo,
+  QueryLeaf,
+  Squongo, // For backwards compatibility
   SqlParserImpl,
   SqlCompilerImpl,
   MongoExecutor,
-  SquongoImpl
+  QueryLeafImpl
 };
 
 // Re-export interfaces

src/interfaces.ts

@@ -107,7 +107,7 @@ export interface CommandExecutor {
 }
 
 /**
- * Main Squongo interface
+ * Main QueryLeaf interface
  */
 export interface Squongo {
   execute(sql: string): Promise<any>;