Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wtnabe/gas-spreadsheet-scheduler

Let you create schedule table on Spreadsheet with Google Apps Script Project
https://github.com/wtnabe/gas-spreadsheet-scheduler

gas-library google-apps-script spreadsheet

Last synced: 1 day ago
JSON representation

Let you create schedule table on Spreadsheet with Google Apps Script Project

Awesome Lists containing this project

README 

        
# SpreadsheetScheduler for Google Apps Script



Let you create schedule table on Spreadsheet with Google Apps Script Project ( Sheets Container-boiund script )



## Prerequisite



Sheets Container-bound script Project



## How to use



### 1. Open Spreadsheet and prepare schedule like below



| A | B | C |

| --- | --- | --- |

| 2023-06-01 | 4日後です |  |

| 日付じゃない |  |  |

| 2023-05-26 | 一昨日です |  |

| 2023-05-27 | 昨日です | ✔️ |

| 2023-05-28 | 当日です |  |



### 2. Open menu [ Extensions ] -> [ Apps Script ]



#### 2-1. Add Library code



Choose one of them please.



 1. add Project ID for you project as Library `1lfmVVWxHmyXqfR8pnFJlDY2P_ys-w96HCZSsoTcGvgQU0AQ9JncLO5w0`

 2. Copy and Paste this code



I would recommend #2 for speed of execution, but #1 is also a good option for administrative costs.



#### 2-2. Prepare code like below



```javascript

/** review past and future plans */

function reviewPlans() {

  const scheduler = SpreadsheetScheduler.createSpreadsheetScheduler()

  const dateUtils = SpreadsheetScheduler.createDateUtils()

  const today = dateUtils.today()

  const range = SpreadsheetApp.getActiveSpreadsheet().getRange('Sheet1!A1:C')



  const [since, until] = dateUtils.thisWeek()



  scheduler.executeWhenMet({

    range,

    selector: (date) => date < since,

    executor: tooooLate,

    skipCol: 2, batch: true

  })



  scheduler.executeWhenMet({

    range,

    selector: (date) => dateUtils.inThisWeek(date) && today <= date,

    executor: hereWeGo,

    skipCol: 2, batch: true

  })

}



/**

 * @param {object} row

 * @param {number} dateCol

 * @param {number} skipCol

 * @returns {string}

 */

function buildRow(row, dateCol, skipCol) {

  const scheduler = SpreadsheetScheduler.createSpreadsheetScheduler()



  return [row[dateCol].toLocaleDateString(), ...scheduler.restOfRow(row)].join('\t')

}



/** display future ( today or later ) plans */

function hereWeGo (values, dateCol, skipCol) {

  if (values.length > 0) {

    console.log('This week\'s remaining plan listed as below:')

    console.log(values.map((row) => buildRow(row, dateCol, skipCol)).join('\n'))

  }

}



/** warn incompleted tasks */

function tooooLate (values, dateCol, skipCol) {

  if (values.length > 0) {

    console.log('Too Late ! Hurry up !')

    console.log(values.map((row) => buildRow(row, dateCol, skipCol)).join('\n'))

  }

}

```



#### Result



If you run on Monday,



```

Too Late ! Hurry up !

5/26/2023	一昨日です

This week's remaining plan listed as below:

6/1/2023	4日後です

5/28/2023	当日です

```



If there are still rows in Spreadsheet containing dates that correspond to `lastWeek()`, they will be output.



If `skipCol` is specified and this column contains some data, it acts as a completion flag, so in the result above, the "yesterday" row is not output.



### 3. create Trigger for repetitive execution



 * 3-1. Switch tab to [ Triggers ] on left side

 * 3-2. Add Trigger from right bottom button



## Features



 * read Spreadsheet Range, and pick schedules with selector function ( default, it detects the very day )

 * invoke action with executor function

 * skip mark column available ( ex, 「完了」 or "Done" )

 * switch batch mode is true ( executor receive whole range values ) or not ( executor receive row array )



## Options



SpreadsheetScheduler.executeWhenMet() function accept these options.







range : Range ( required )


Google Spreadsheet Range Object. read values 




executor : Function ( optional / dumpRow() or dumpRange() )






selector : Funtion ( optional / isAppointedDay() )






dateCol : Integer ( optional / default 0 )






skipCol : Integer ( optional / default `undefined` )






batch : Boolean ( optional / default `false` )





### Selector Function



The Selector Function has one argument.



 * date



and should return Boolean. ( used with Array.prototype.filter() )



You can write any function about date determination.



```javascript

  scheduler.executeWhenMet({

    range: SpreadsheetApp.getActiveSpreadsheet().getRange('Sheet1!A1:B'),

    selector: (date) => date >= from && date < to,

    ..

  })

```



### Executor Function



The Executor Function has two modes.



1. row mode ( default )



receives the following arguments



 * row ( Array )

 * dateCol

 * skipCol



The built-in dumpRow() function is the dead simple example.



2. batch mode ( when `batch` options is true )



receives the following arguments



 * values ( Array of Array )

 * dateCol

 * skipCol



The built-in dumpRange() function is the dead simple example, too.