Steps to generate a GoogleAppsScript.Document.Text object

Question

Steps to generate a GoogleAppsScript.Document.Text object

I am looking to conduct unit testing on this Typescript code that has been transpiled using Clasp into Google App Script:

function onLinksInText(text: GoogleAppsScript.Document.Text, onLink: OnLinkCallback) {
    const iterator = new TextIterator(text, onLink)
    const characters = text.getText();
    for (let i = 0; i < characters.length; i++) {
        iterator.handle(i, text.getLinkUrl(i));
    }
    iterator.end()
}

In order to proceed with the unit testing, I must initialize an instance of GoogleAppsScript.Document.Text

Could you please guide me on how to achieve that?

typescript google-apps-script mocking google-docs clasp

Answer 1

Answer №1

Summary

To effectively test the function, you need to create a mock for the class.

Detailed Explanation

In order to properly test the functionality of the function, it is essential to simulate the behavior of the constructor, getText, and getLinkUrl methods through mocking. Additionally, it is recommended to also mock the setText method for better accuracy:

function TextFactory() {

  const linkMatcher = /https?:\/\/(?:www\.)?(?:\.{0,1}(?:\w|-)+)+/ig;

  let private = "";
  
  return {
    setText(text) {
      private = text.toString();
      return this;
    },
    getText() {
      return private;
    },
    getLinkUrl(offset) {
      const idx = private.search(linkMatcher);
            
      if(idx < 0 || offset > idx ) { return null; }
      
      return private.slice(idx);
    }
  };
}

const mock = TextFactory();
mock.setText("Find me at https://example.com ");

console.log(mock.getText());
console.log(mock.getLinkUrl(4));
console.log(mock.getLinkUrl(12));

Assuming that TextIterator represents your custom class, a basic shallow mock has been created for illustrative purposes:

function TextFactory() {

  const linkMatcher = /https?:\/\/(?:www\.)?(?:\.{0,1}(?:\w|-)+)+/ig;

  let private = "";
  
  return {
    setText(text) {
      private = text.toString();
      return this;
    },
    getText() {
      return private;
    },
    getLinkUrl(offset) {
      const idx = private.search(linkMatcher);
            
      if(idx < 0 || offset > idx ) { return null; }
      
      return private.slice(idx);
    }
  };
}

const mock = TextFactory();
mock.setText("Find me at https://example.com ");

class TextIterator {

  constructor(text, onLink) {
    this.text = text;
    this.callback = onLink;
  }

  handle(index, link) {
    this.callback(`${link} at index ${index}`);
  }

  end() {
    console.log("ended");
  }
}


function onLinksInText(text, onLink) {
    const iterator = new TextIterator(text, onLink)
    const characters = text.getText();
    for (let i = 0; i < characters.length; i++) {
        iterator.handle(i, text.getLinkUrl(i));
    }
    iterator.end()
}

onLinksInText(mock, console.log );

Additional Resources

Text class documentation

Answer 2

Summary

To effectively test the function, you need to create a mock for the class.

Detailed Explanation

In order to properly test the functionality of the function, it is essential to simulate the behavior of the constructor, getText, and getLinkUrl methods through mocking. Additionally, it is recommended to also mock the setText method for better accuracy:

function TextFactory() {

  const linkMatcher = /https?:\/\/(?:www\.)?(?:\.{0,1}(?:\w|-)+)+/ig;

  let private = "";
  
  return {
    setText(text) {
      private = text.toString();
      return this;
    },
    getText() {
      return private;
    },
    getLinkUrl(offset) {
      const idx = private.search(linkMatcher);
            
      if(idx < 0 || offset > idx ) { return null; }
      
      return private.slice(idx);
    }
  };
}

const mock = TextFactory();
mock.setText("Find me at https://example.com ");

console.log(mock.getText());
console.log(mock.getLinkUrl(4));
console.log(mock.getLinkUrl(12));

Assuming that TextIterator represents your custom class, a basic shallow mock has been created for illustrative purposes:

function TextFactory() {

  const linkMatcher = /https?:\/\/(?:www\.)?(?:\.{0,1}(?:\w|-)+)+/ig;

  let private = "";
  
  return {
    setText(text) {
      private = text.toString();
      return this;
    },
    getText() {
      return private;
    },
    getLinkUrl(offset) {
      const idx = private.search(linkMatcher);
            
      if(idx < 0 || offset > idx ) { return null; }
      
      return private.slice(idx);
    }
  };
}

const mock = TextFactory();
mock.setText("Find me at https://example.com ");

class TextIterator {

  constructor(text, onLink) {
    this.text = text;
    this.callback = onLink;
  }

  handle(index, link) {
    this.callback(`${link} at index ${index}`);
  }

  end() {
    console.log("ended");
  }
}


function onLinksInText(text, onLink) {
    const iterator = new TextIterator(text, onLink)
    const characters = text.getText();
    for (let i = 0; i < characters.length; i++) {
        iterator.handle(i, text.getLinkUrl(i));
    }
    iterator.end()
}

onLinksInText(mock, console.log );

Additional Resources

Text class documentation

Steps to generate a GoogleAppsScript.Document.Text object

Answer №1

Similar questions

What are the limitations of using concatMap for handling multiple requests simultaneously?

What is the process for linking my component to my socket.io server?

Dropzone and Typescript: A Powerful Combination

Node appears to be struggling to find the cors

Utilizing PrimeNG dropdowns within various p-tree nodes: Distinguishing between selected choices

Utilize generic types as object properties in TypeScript

callback triggering state change

The behavior of an Angular 2 method varies depending on whether it is called in ngOnInit or triggered by a button

Angular/Typescript: Getting the enum name instead of its value in a key-value pair

Discovering the Error Message within the Error Object transmitted by NodeJS to Angular

Angular project icons not displaying in the browser

What are the best ways to incorporate a theme into your ReactJS project?

Can inner function calls be mimicked?

Issue with triggering blur event in Internet Explorer while using Angular 2+

Use ng2-select2 directive to connect a reactive form formControlName

Adal TypeScript Document

Incorporating the Chartist plugin into an Angular 5 application

Having issues with using the class selector in SVG.select() method of the svg.js library when working with TypeScript

Conceal components using routing in Angular2 release candidate 1

Transforming data objects into simplified interfaces using Typescript