Merge pull request #48 from singerla/feature-cache

Feature cache

Author: singerla

.gitignore

@@ -10,8 +10,10 @@ workspace.code-workspace
 ### Testing
 __tests__/images
 coverage/
+__tests__/pptx-output/
+__tests__/pptx-cache/
 
 ### Customer related files
 __customer__/
-__tests__/pptx-output/
 src/dev-customer.ts
+

src/automizer.ts

@@ -1,8 +1,8 @@
 import { Slide } from './classes/slide';
-import { FileHelper } from './helper/file-helper';
 import {
   AutomizerParams,
   AutomizerSummary,
+  ArchiveParams,
   SourceSlideIdentifier,
   StatusTracker,
 } from './types/types';
@@ -17,9 +17,7 @@ import path from 'path';
 import * as fs from 'fs';
 import { XmlHelper } from './helper/xml-helper';
 import ModifyPresentationHelper from './helper/modify-presentation-helper';
-import { contentTracker, ContentTracker } from './helper/content-tracker';
-import JSZip from 'jszip';
-import { CacheHelper } from './helper/cache-helper';
+import { ContentTracker } from './helper/content-tracker';
 
 /**
  * Automizer
@@ -37,7 +35,7 @@ export default class Automizer implements IPresentationProps {
   templateDir: string;
   templateFallbackDir: string;
   outputDir: string;
-  cacheDir: string;
+  archiveParams: ArchiveParams;
   /**
    * Timer of automizer
    * @internal
@@ -62,10 +60,13 @@ export default class Automizer implements IPresentationProps {
       ? params.templateFallbackDir + '/'
       : '';
     this.outputDir = params?.outputDir ? params.outputDir + '/' : '';
-    this.cacheDir = params?.cacheDir
-      ? params.cacheDir
-      : __dirname + '/../cache';
-    CacheHelper.setDir(this.cacheDir);
+
+    this.archiveParams = <ArchiveParams>{
+      mode: params?.archiveType?.mode || 'jszip',
+      baseDir: params?.archiveType?.baseDir || __dirname + '/../cache',
+      workDir: params?.archiveType?.workDir || 'tmp',
+      cleanupWorkDir: params?.archiveType?.cleanupWorkDir,
+    };
 
     this.timer = Date.now();
     this.setStatusTracker(params?.statusTracker);
@@ -74,13 +75,24 @@ export default class Automizer implements IPresentationProps {
 
     if (params.rootTemplate) {
       const location = this.getLocation(params.rootTemplate, 'template');
-      this.rootTemplate = Template.import(location) as RootPresTemplate;
+      this.rootTemplate = Template.import(
+        location,
+        this.archiveParams,
+      ) as RootPresTemplate;
     }
 
     if (params.presTemplates) {
       this.params.presTemplates.forEach((file) => {
         const location = this.getLocation(file, 'template');
-        const newTemplate = Template.import(location, file) as PresTemplate;
+        const archiveParams = {
+          ...this.archiveParams,
+          name: file,
+        };
+        const newTemplate = Template.import(
+          location,
+          archiveParams,
+        ) as PresTemplate;
+
         this.templates.push(newTemplate);
       });
     }
@@ -158,7 +170,12 @@ export default class Automizer implements IPresentationProps {
       return this;
     }
 
-    const newTemplate = Template.import(location, name);
+    const importParams = {
+      ...this.archiveParams,
+      name,
+    };
+
+    const newTemplate = Template.import(location, importParams);
 
     if (!this.isPresTemplate(newTemplate)) {
       this.rootTemplate = newTemplate;

src/classes/template.ts

@@ -10,6 +10,7 @@ import { SlideInfo } from '../types/xml-types';
 import { XmlHelper } from '../helper/xml-helper';
 import { ContentTracker } from '../helper/content-tracker';
 import IArchive from '../interfaces/iarchive';
+import { ArchiveParams } from '../types/types';
 
 export class Template implements ITemplate {
   /**
@@ -51,22 +52,22 @@ export class Template implements ITemplate {
   creationIds: SlideInfo[];
   existingSlides: number;
 
-  constructor(location: string) {
+  constructor(location: string, params: ArchiveParams) {
     this.location = location;
-    const archive = FileHelper.importArchive(location);
+    const archive = FileHelper.importArchive(location, params);
     this.archive = archive;
   }
 
   static import(
     location: string,
-    name?: string,
+    params: ArchiveParams,
   ): PresTemplate | RootPresTemplate {
     let newTemplate: PresTemplate | RootPresTemplate;
-    if (name) {
-      newTemplate = new Template(location) as PresTemplate;
-      newTemplate.name = name;
+    if (params.name) {
+      newTemplate = new Template(location, params) as PresTemplate;
+      newTemplate.name = params.name;
     } else {
-      newTemplate = new Template(location) as RootPresTemplate;
+      newTemplate = new Template(location, params) as RootPresTemplate;
       newTemplate.slides = [];
       newTemplate.counter = [
         new CountHelper('slides', newTemplate),

src/dev.ts

@@ -1,21 +1,33 @@
 import { vd } from './helper/general-helper';
 import Automizer, { modify } from './index';
 
+const outputName = 'create-presentation-file-proxy.test.pptx';
 const automizer = new Automizer({
   templateDir: `${__dirname}/../__tests__/pptx-templates`,
   outputDir: `${__dirname}/../__tests__/pptx-output`,
-  // cacheDir: `${__dirname}/../__tests__/pptx-cache`,
+  archiveType: {
+    mode: 'fs',
+    baseDir: `${__dirname}/../__tests__/pptx-cache`,
+    workDir: outputName,
+    cleanupWorkDir: true,
+  },
+  rootTemplate: 'RootTemplateWithImages.pptx',
+  presTemplates: [
+    `RootTemplate.pptx`,
+    `SlideWithImages.pptx`,
+    `ChartBarsStacked.pptx`,
+  ],
   removeExistingSlides: true,
   cleanup: true,
-  compression: 5,
+  compression: 0,
 });
 
 const run = async () => {
-  const pres = automizer
-    .loadRoot(`RootTemplateWithImages.pptx`)
-    .load(`RootTemplate.pptx`, 'root')
-    .load(`SlideWithImages.pptx`, 'images')
-    .load(`ChartBarsStacked.pptx`, 'charts');
+  // const pres = automizer
+  //   .loadRoot(`RootTemplateWithImages.pptx`)
+  //   .load(`RootTemplate.pptx`, 'root')
+  //   .load(`SlideWithImages.pptx`, 'images')
+  //   .load(`ChartBarsStacked.pptx`, 'charts');
 
   const dataSmaller = {
     series: [{ label: 'series s1' }, { label: 'series s2' }],
@@ -25,24 +37,28 @@ const run = async () => {
     ],
   };
 
-  const result = await pres
-    .addSlide('charts', 1, (slide) => {
+  const result = await automizer
+    .addSlide('ChartBarsStacked.pptx', 1, (slide) => {
       slide.modifyElement('BarsStacked', [modify.setChartData(dataSmaller)]);
-      slide.addElement('charts', 1, 'BarsStacked', [
+      slide.addElement('ChartBarsStacked.pptx', 1, 'BarsStacked', [
         modify.setChartData(dataSmaller),
       ]);
     })
-    .addSlide('images', 1)
-    .addSlide('root', 1, (slide) => {
-      slide.addElement('charts', 1, 'BarsStacked', [
+    .addSlide('SlideWithImages.pptx', 1)
+    .addSlide('RootTemplate.pptx', 1, (slide) => {
+      slide.addElement('ChartBarsStacked.pptx', 1, 'BarsStacked', [
         modify.setChartData(dataSmaller),
       ]);
     })
-    .addSlide('charts', 1, (slide) => {
-      slide.addElement('images', 2, 'imageJPG');
-      // slide.modifyElement('BarsStacked', [modify.setChartData(dataSmaller)]);
+    .addSlide('ChartBarsStacked.pptx', 1, (slide) => {
+      slide.addElement('SlideWithImages.pptx', 2, 'imageJPG');
+      slide.modifyElement('BarsStacked', [modify.setChartData(dataSmaller)]);
+    })
+    .addSlide('ChartBarsStacked.pptx', 1, (slide) => {
+      slide.addElement('SlideWithImages.pptx', 2, 'imageJPG');
+      slide.modifyElement('BarsStacked', [modify.setChartData(dataSmaller)]);
     })
-    .write(`create-presentation-file-proxy.test.pptx`);
+    .write(outputName);
 
   vd(result.duration);
   // vd(pres.rootTemplate.content);