Last active
May 12, 2024 02:13
-
-
Save dimitrispaxinos/7eda38c7faf8f55910e056a77a2fc737 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | |
| * Constants for boolean settings values. | |
| */ | |
| const YES = 'Yes'; | |
| const NO = 'No'; | |
| /** | |
| * The Settings class provides a way to manage script parameters/settings | |
| * directly within a Google Sheet, making it accessible for non-technical users. | |
| */ | |
| class Settings { | |
| /** | |
| * Constructor initializes the settings sheet and map. | |
| * @param {string} [sheetName="Settings"] - Name of the sheet where settings are stored. | |
| */ | |
| constructor(sheetName = "Settings") { | |
| this.sheetName = sheetName; | |
| this.spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); | |
| this.settingsSheet = this.spreadsheet.getSheetByName(sheetName); | |
| this.settingsMap = this.initSettingsMap(); | |
| } | |
| /** | |
| * Initializes the settings sheet if it doesn't exist. | |
| */ | |
| init() { | |
| if (!this.settingsSheet) { | |
| this.settingsSheet = this.spreadsheet.insertSheet(this.sheetName); | |
| this.settingsSheet.appendRow(['Setting', 'Value']); | |
| this.settingsSheet.getRange('1:1').setFontWeight('bold'); | |
| } | |
| } | |
| /** | |
| * Initializes the settings map from the sheet data. | |
| * @returns {Map} - A map of settings. | |
| */ | |
| initSettingsMap() { | |
| if (!this.settingsSheet) return new Map(); | |
| const data = this.settingsSheet.getDataRange().getValues(); | |
| const map = new Map(); | |
| for (const [key, value] of data) { | |
| map.set(key, value); | |
| } | |
| return map; | |
| } | |
| /** | |
| * Sets or updates a setting in the sheet. | |
| * @param {string} settingName - Name of the setting. | |
| * @param {string} settingValue - Value of the setting. | |
| */ | |
| setSetting(settingName, settingValue) { | |
| const rowIndex = [...this.settingsMap.keys()].indexOf(settingName) + 1; | |
| if (rowIndex > 0) { | |
| this.settingsSheet.getRange(rowIndex, 2).setValue(settingValue); | |
| } else { | |
| this.settingsSheet.appendRow([settingName, settingValue]); | |
| } | |
| this.settingsMap.set(settingName, settingValue); | |
| } | |
| /** | |
| * Retrieves a setting's value from the map. | |
| * @param {string} settingName - Name of the setting. | |
| * @returns {string|null} - Value of the setting or null if not found. | |
| */ | |
| getSetting(settingName) { | |
| return this.settingsMap.get(settingName) || null; | |
| } | |
| /** | |
| * Retrieves a boolean setting's value. | |
| * @param {string} settingName - Name of the setting. | |
| * @returns {boolean|null} - True if 'Yes', False if 'No', or null if neither. | |
| */ | |
| getBooleanSetting(settingName) { | |
| const settingValue = this.getSetting(settingName); | |
| if (settingValue === YES) return true; | |
| if (settingValue === NO) return false; | |
| Logger.log(`Setting value is not ${YES} or ${NO}: ${settingName}`); | |
| return null; | |
| } | |
| /** | |
| * Sets a setting in the script properties. | |
| * @param {string} settingName - Name of the setting. | |
| * @param {string} settingValue - Value of the setting. | |
| */ | |
| setSettingInScriptProperties(settingName, settingValue) { | |
| PropertiesService.getScriptProperties().setProperty(settingName, settingValue); | |
| } | |
| /** | |
| * Retrieves a setting from the script properties. | |
| * @param {string} settingName - Name of the setting. | |
| * @returns {string} - Value of the setting. | |
| */ | |
| getSettingFromScriptProperties(settingName) { | |
| return PropertiesService.getScriptProperties().getProperty(settingName); | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment