refactor(plpgsql-deparser): use pretty print and creative lowercase names

- Enable pretty print option for SQL deparser
- Rename function: big_kitchen_sink -> order_rollup_calculator
- Rename variables: v_discount -> v_rebate, v_tax -> v_levy
- Change default values: 0 -> 42

Author: pyramation

packages/plpgsql-deparser/__tests__/__snapshots__/hydrate-demo.test.ts.snap

@@ -1,16 +1,16 @@
 // Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`hydrate demonstration with big-function.sql should parse, hydrate, modify, and deparse big-function.sql with full CREATE FUNCTION 1`] = `
-"CREATE OR REPLACE FUNCTION app_public."big_kitchen_sink_MODIFIED"(p_org_id uuid, p_user_id uuid, p_from_ts timestamptz DEFAULT now() - '30 days'::interval, p_to_ts timestamptz DEFAULT now(), p_min_total numeric DEFAULT 0, p_max_rows int DEFAULT 250, p_currency text DEFAULT 'USD', p_apply_discount boolean DEFAULT true, p_discount_rate numeric DEFAULT 0.05, p_tax_rate numeric DEFAULT 0.0875, p_round_to int DEFAULT 2, p_note text DEFAULT NULL, p_lock boolean DEFAULT false, p_debug boolean DEFAULT false) RETURNS TABLE ( org_id uuid, user_id uuid, period_from timestamptz, period_to timestamptz, orders_scanned int, orders_upserted int, gross_total numeric, discount_total numeric, tax_total numeric, net_total numeric, avg_order_total numeric, top_sku text, top_sku_qty bigint, message text ) LANGUAGE plpgsql AS $$DECLARE
-  v_orders_scanned int := 888;
-  v_orders_upserted int := 888;
-  v_gross numeric := 888;
-  v_discount numeric := 888;
-  v_tax numeric := 888;
-  v_net numeric := 888;
-  v_avg numeric := 888;
+"CREATE OR REPLACE FUNCTION app_public.order_rollup_calculator(p_org_id uuid, p_user_id uuid, p_from_ts timestamptz DEFAULT now() - '30 days'::interval, p_to_ts timestamptz DEFAULT now(), p_min_total numeric DEFAULT 0, p_max_rows int DEFAULT 250, p_currency text DEFAULT 'USD', p_apply_discount boolean DEFAULT true, p_discount_rate numeric DEFAULT 0.05, p_tax_rate numeric DEFAULT 0.0875, p_round_to int DEFAULT 2, p_note text DEFAULT NULL, p_lock boolean DEFAULT false, p_debug boolean DEFAULT false) RETURNS TABLE ( org_id uuid, user_id uuid, period_from timestamptz, period_to timestamptz, orders_scanned int, orders_upserted int, gross_total numeric, discount_total numeric, tax_total numeric, net_total numeric, avg_order_total numeric, top_sku text, top_sku_qty bigint, message text ) LANGUAGE plpgsql AS $$DECLARE
+  v_orders_scanned int := 42;
+  v_orders_upserted int := 42;
+  v_gross numeric := 42;
+  v_discount numeric := 42;
+  v_tax numeric := 42;
+  v_net numeric := 42;
+  v_avg numeric := 42;
   v_top_sku text := NULL;
-  v_top_sku_qty bigint := 888;
+  v_top_sku_qty bigint := 42;
   v_now timestamptz := clock_timestamp();
   v_jitter numeric := (random() - 0.5) * 0.02;
   v_discount_rate numeric := GREATEST(LEAST(p_discount_rate, 0.50), 0);
@@ -70,11 +70,11 @@ END IF;
     t.avg_total
                                                       FROM totals t;
     IF p_apply_discount THEN
-      v_discount_MODIFIED := round(v_gross * GREATEST(LEAST(v_discount_rate + v_jitter, 0.50), 0), p_round_to);
+      v_rebate := round(v_gross * GREATEST(LEAST(v_discount_rate + v_jitter, 0.50), 0), p_round_to);
 ELSE
       v_discount := 0;
 END IF;
-    v_tax_MODIFIED := round(GREATEST(v_gross - v_discount, 0) * v_tax_rate, p_round_to);
+    v_levy := round(GREATEST(v_gross - v_discount, 0) * v_tax_rate, p_round_to);
     v_net := round((v_gross - v_discount + v_tax) * power(10::numeric, 0), p_round_to);
     SELECT
     oi.sku,

packages/plpgsql-deparser/__tests__/hydrate-demo.test.ts

@@ -34,7 +34,7 @@ describe('hydrate demonstration with big-function.sql', () => {
     expect(stats.failedExpressions).toBe(0);
     expect(stats.rawExpressions).toBe(0);
 
-    createFunctionStmt.funcname[1].String.sval = 'big_kitchen_sink_MODIFIED';
+    createFunctionStmt.funcname[1].String.sval = 'order_rollup_calculator';
 
     const modifiedPlpgsqlAst = modifyAst(JSON.parse(JSON.stringify(hydratedAst)));
 
@@ -46,14 +46,14 @@ describe('hydrate demonstration with big-function.sql', () => {
       asOption.DefElem.arg.List.items[0].String.sval = modifiedBody;
     }
 
-    const fullDeparsed = await deparse(sqlParsed.stmts[0].stmt);
+    const fullDeparsed = await deparse(sqlParsed.stmts[0].stmt, { pretty: true });
 
-    expect(fullDeparsed).toContain('big_kitchen_sink_MODIFIED');
+    expect(fullDeparsed).toContain('order_rollup_calculator');
     expect(fullDeparsed).toContain('RETURNS TABLE');
     expect(fullDeparsed).toContain('CREATE OR REPLACE FUNCTION');
-    expect(fullDeparsed).toContain('v_discount_MODIFIED');
-    expect(fullDeparsed).toContain('v_tax_MODIFIED');
-    expect(fullDeparsed).toContain('888');
+    expect(fullDeparsed).toContain('v_rebate');
+    expect(fullDeparsed).toContain('v_levy');
+    expect(fullDeparsed).toContain('42');
 
     expect(fullDeparsed).toMatchSnapshot();
   });
@@ -103,24 +103,24 @@ function modifyAst(ast: any): any {
 
         if (typeof query === 'object' && query.kind === 'assign') {
           if (query.target === 'v_discount' && assignModCount === 0) {
-            query.target = 'v_discount_MODIFIED';
+            query.target = 'v_rebate';
             assignModCount++;
             modCount++;
           }
           if (query.target === 'v_tax' && assignModCount === 1) {
-            query.target = 'v_tax_MODIFIED';
+            query.target = 'v_levy';
             assignModCount++;
             modCount++;
           }
           if (query.value === '0' && modCount < 5) {
-            query.value = '999';
+            query.value = '42';
             modCount++;
           }
         }
 
         if (typeof query === 'object' && query.kind === 'sql-expr') {
           if (query.original === '0' && modCount < 8) {
-            query.original = '888';
+            query.original = '42';
             modCount++;
           }
         }