Merge pull request #9 from dedoussis/refactor-treeifier

refactor(utils.ts): Treefier extraced from Node.ts to utils.ts
dedoussis · Apr 13, 2020 · cd25e73 · cd25e73
2 parents f1e397c + 3c99f24
commit cd25e73
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 48 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ compiled
 .rpt2_cache
 docs
 .antlr
+.npmrc
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "algebrain",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Combuter Algebra System focusing on symbolic transformations",
   "keywords": [
     "algebra",

diff --git a/src/Command.ts b/src/Command.ts
@@ -2,6 +2,7 @@ import { List, Map } from 'immutable';
 import Executable, { Namespace, Output } from './Executable';
 import Node from './Node';
 import simplification from './transformations/simplification';
+import { treeify } from './utils';
 
 export enum CommandName {
     Transform = 'transform',
@@ -48,7 +49,7 @@ export const commandRegistry: Map<CommandName, CommandSpec> = Map([
                     stdOut: transformed.toString(),
                 };
             },
-            description: 'Transform current expression using the active transformation',
+            description: 'Transform the current expression',
         },
     ],
     [
@@ -70,7 +71,7 @@ export const commandRegistry: Map<CommandName, CommandSpec> = Map([
                     stdOut: evaluated.toString(),
                 };
             },
-            description: 'Evaluate current expression',
+            description: 'Evaluate the current expression',
         },
     ],
     [
@@ -100,7 +101,7 @@ export const commandRegistry: Map<CommandName, CommandSpec> = Map([
                 };
             },
             description:
-                'List rules of given transformation - Requires transformation name as a string parameter',
+                'List the rules of a given transformation - Requires transformation name as a string parameter',
         },
     ],
     [
@@ -136,10 +137,10 @@ export const commandRegistry: Map<CommandName, CommandSpec> = Map([
                 }
                 return {
                     namespace: namespace,
-                    stdOut: namespace.expression.treeify('', '\xa0'),
+                    stdOut: treeify(namespace.expression),
                 };
             },
-            description: 'Tree representation of expression',
+            description: 'Tree representation of the expression',
         },
     ],
     [
@@ -151,7 +152,7 @@ export const commandRegistry: Map<CommandName, CommandSpec> = Map([
                     stdOut: `[ ${namespace.transformations.keySeq().join(', ')} ]`,
                 };
             },
-            description: 'List all defined transformations',
+            description: 'List all the defined transformations',
         },
     ],
 ]);

diff --git a/src/Node.ts b/src/Node.ts
@@ -25,10 +25,6 @@ export default abstract class Node implements Executable {
         return this;
     }
 
-    treeify(childPrefix: string, space: string): string {
-        return this.toString();
-    }
-
     transform(
         defaultTransformation: Transformation,
         transformationMap: TransformationMap = Map()
@@ -151,20 +147,6 @@ export class Operator extends Node {
         return infix(this.value, stringifiedChildren);
     }
 
-    treeify(childPrefix: string, space: string): string {
-        return this.children.reduce(
-            (treeified: string, child: Node, index: number, children: List<Node>) => {
-                const [branch, prefixExtention]: [string, string] =
-                    index === children.size - 1 ? ['└─', space] : ['├─', '│'];
-                return `${treeified}\n${childPrefix}${branch} ${child.treeify(
-                    `${childPrefix}${prefixExtention}${space}${space}`,
-                    space
-                )}`;
-            },
-            this.value
-        );
-    }
-
     transform(
         defaultTransformation: Transformation,
         transformationMap: TransformationMap = Map()

diff --git a/src/Transformation.ts b/src/Transformation.ts
@@ -1,6 +1,7 @@
 import { List } from 'immutable';
 import Executable, { Namespace, Output } from './Executable';
 import Rule from './Rule';
+import { indent, newLine } from './utils';
 
 export default class Transformation implements Executable {
     constructor(readonly name: string, readonly rules: List<Rule> = List()) {}
@@ -10,7 +11,8 @@ export default class Transformation implements Executable {
     }
 
     toString(): string {
-        return `[\n\xa0\xa0${this.rules.join(`,\n\xa0\xa0`)}\n]`;
+        const newLineIndent = newLine + indent;
+        return '[' + newLineIndent + this.rules.join(',' + newLineIndent) + newLine + ']';
     }
 
     equals(other: any): boolean {

diff --git a/src/utils.ts b/src/utils.ts
@@ -19,3 +19,25 @@ export const and = generateOperator(OperatorSymbol.And);
 export const or = generateOperator(OperatorSymbol.Or);
 export const flag = generateOperator(OperatorSymbol.Flag);
 export const equals = generateOperator(OperatorSymbol.Equals);
+
+export const space = ' ';
+export const newLine = '\n';
+export const indent = space.repeat(2);
+
+export function treeify(node: Node, childPrefix = ''): string {
+    if (!(node instanceof Operator)) {
+        return node.toString();
+    }
+
+    return node.children.reduce(
+        (treeified: string, child: Node, index: number, children: List<Node>) => {
+            const [branch, prefixExtention] =
+                index === children.size - 1 ? ['└─', space] : ['├─', '│'];
+            const newPrefix = childPrefix + prefixExtention + indent;
+            const treefiedChild = treeify(child, newPrefix);
+            const prefixedTreefiedChild = childPrefix + branch + space + treefiedChild;
+            return treeified + newLine + prefixedTreefiedChild;
+        },
+        node.value
+    );
+}
diff --git a/test/node.test.ts b/test/node.test.ts
@@ -311,23 +311,4 @@ describe('Operator', () => {
         );
         expect(one.equals(another)).toBeFalsy();
     });
-
-    it('it treeifies', () => {
-        const expr: Operator = div(
-            plus(minus(new Rewritable('u'), new Symbol('x')), new Num(5)),
-            pow(new Symbol('g'), new Num(5))
-        );
-        const treefied: string[] = [
-            '/',
-            '├─ +',
-            '│  ├─ -',
-            '│  │  ├─ $u',
-            '│  │  └─ x',
-            '│  └─ 5',
-            '└─ ^',
-            '   ├─ g',
-            '   └─ 5',
-        ];
-        expect(expr.treeify('', ' ')).toEqual(treefied.join('\n'));
-    });
 });
diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -1,6 +1,16 @@
 import { List } from 'immutable';
-import { generateOperator, OperatorGenerator, plus, minus, mul, div, pow } from '../src/utils';
-import { Operator, OperatorSymbol, Num } from '../src/Node';
+import {
+    generateOperator,
+    OperatorGenerator,
+    plus,
+    minus,
+    mul,
+    div,
+    pow,
+    treeify,
+    newLine,
+} from '../src/utils';
+import { Operator, OperatorSymbol, Num, Rewritable, Symbol } from '../src/Node';
 
 describe('generateOperator', () => {
     it('generates any given operator symbol', () => {
@@ -33,3 +43,24 @@ describe('generateOperator', () => {
         expect(new Operator(OperatorSymbol.Pow).equals(operator)).toBeTruthy;
     });
 });
+
+describe('treeifier', () => {
+    it('it treeifies', () => {
+        const expr = div(
+            plus(minus(new Rewritable('u'), new Symbol('x')), new Num(5)),
+            pow(new Symbol('g'), new Num(5))
+        );
+        const expected = [
+            '/',
+            '├─ +',
+            '│  ├─ -',
+            '│  │  ├─ $u',
+            '│  │  └─ x',
+            '│  └─ 5',
+            '└─ ^',
+            '   ├─ g',
+            '   └─ 5',
+        ].join(newLine);
+        expect(treeify(expr)).toEqual(expected);
+    });
+});