Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 | import API from 'src/classes/API'; import Lng from 'src/classes/Lng'; import { Logging } from 'src/classes/Logging'; import { IProcessorSettings } from 'src/interfaces/IProcessorSettings'; import { IPrjTaskManagementData } from 'src/models/Data/interfaces/IPrjTaskManagementData'; import PrjBaseData from 'src/models/Data/PrjBaseData'; import PrjProjectData from 'src/models/Data/PrjProjectData'; import PrjTaskData from 'src/models/Data/PrjTaskData'; import PrjTopicData from 'src/models/Data/PrjTopicData'; import { PrjTaskManagementModel } from 'src/models/PrjTaskManagementModel'; import { Priority } from 'src/types/PrjTypes'; import FilterButton from './InnerComponents/FilterButton'; import GeneralComponents from './InnerComponents/GeneralComponents'; import MaxShownModelsInput from './InnerComponents/MaxShownModelsInput'; import ProjectComponents from './InnerComponents/ProjectComponents'; import SearchInput from './InnerComponents/SearchInput'; import TableBlockRenderComponent, { BlockRenderSettings, } from './TableBlockRenderComponent'; import { FileTypes } from '../FileType/interfaces/IFileType'; import { HelperGeneral } from '../Helper/General'; import { FileMetadata } from '../MetadataCache'; import { StatusTypes } from '../StatusType/interfaces/IStatusType'; import Table, { Row, TableHeader } from '../Table'; import { Tags } from '../Tags/Tags'; /** * Represents a block render component for `PrjTaskManagementModel`. */ export default class ProjectBlockRenderComponent extends TableBlockRenderComponent< PrjTaskManagementModel<IPrjTaskManagementData & PrjBaseData<unknown>> > { private _filterButtonDebounceTimer: NodeJS.Timeout; protected _settings: BlockRenderSettings = { tags: [], reactOnActiveFile: false, filter: ['Topic', 'Project', 'Task'], maxDocuments: this._IPrjSettings.defaultMaxShow, search: undefined, searchText: undefined, batchSize: 8, sleepBetweenBatches: 10, }; /** * The table headers. * @remarks The table headers are used to create the table. */ protected _tableHeaders: TableHeader[] = [ { text: Lng.gt('DocumentType'), headerClass: [], columnClass: ['dont-decorate-link', 'font-medium'], }, { text: Lng.gt('TraficLight'), headerClass: [], columnClass: [] }, { text: Lng.gt('Description'), headerClass: [], columnClass: ['dont-decorate-link', 'link-weight-bold'], }, { text: Lng.gt('Priority'), headerClass: [], columnClass: [] }, { text: Lng.gt('Due date'), headerClass: [], columnClass: ['font-xsmall'], }, { text: Lng.gt('Status'), headerClass: [], columnClass: [] }, { text: Lng.gt('Tags'), headerClass: [], columnClass: ['tags'] }, ]; /** * Creates an instance of `ProjectBlockRenderComponent`. * @param settings The settings for the processor. */ constructor(settings: IProcessorSettings) { super(settings); this.parseSettings(); } /** * Build the basic structure of the component. * @returns A promise that resolves when the component is built. */ public build(): Promise<void> { return super.build(); } /** * Redraw the component. * @returns A promise that resolves when the component is redrawn. */ public redraw(): Promise<void> { return super.redraw(); } /** * Draw the component. * @returns A promise that resolves when the component is drawn. */ protected async draw(): Promise<void> { const startTime = Date.now(); const getModelsPromise = super.getModels( ['Topic', 'Project', 'Task'], this._settings.tags, (metadata: FileMetadata) => API.prjTaskManagementModel.getCorospondingModel(metadata.file), ); await super.draw(); await this.buildTable(); await this.buildHeader(); this.grayOutHeader(); this._models = await getModelsPromise; API.prjTaskManagementModel.sortModelsByUrgency( this._models as PrjTaskManagementModel< PrjTaskData | PrjTopicData | PrjProjectData >[], ); await this.addDocumentsToTable(); this.normalizeHeader(); const endTime = Date.now(); this._logger?.debug( `Redraw (for ${this._models.length} Models) runs for ${endTime - startTime}ms`, ); } /** * Build the basic table structure. */ private async buildTable(): Promise<void> { this._table = new Table( this._tableHeaders, 'project-table', undefined, Logging.getLogger('ProjectBlockRenderComponent/Table'), ); this._tableContainer.appendChild(this._table.data.table); } /** * Build the header of the component. */ private async buildHeader(): Promise<void> { // Filter container const headerFilterButtons = document.createElement('div'); this._headerContainer.appendChild(headerFilterButtons); headerFilterButtons.classList.add('header-item'); headerFilterButtons.classList.add('filter-symbols'); // Filter label const filterLabelContainer = document.createElement('div'); headerFilterButtons.appendChild(filterLabelContainer); const filterLabel = document.createElement('span'); filterLabelContainer.appendChild(filterLabel); filterLabel.classList.add('filter-symbol'); filterLabel.textContent = Lng.gt('Filter'); const topicFilterButton = FilterButton.create( this._component, 'Topic', this._IPrjSettings.prjSettings.topicSymbol, this._settings.filter.includes('Topic'), this.onFilterButton.bind(this), ); headerFilterButtons.appendChild(topicFilterButton); const projectFilterButton = FilterButton.create( this._component, 'Project', this._IPrjSettings.prjSettings.projectSymbol, this._settings.filter.includes('Project'), this.onFilterButton.bind(this), ); headerFilterButtons.appendChild(projectFilterButton); const taskFilterButton = FilterButton.create( this._component, 'Task', this._IPrjSettings.prjSettings.taskSymbol, this._settings.filter.includes('Task'), this.onFilterButton.bind(this), ); headerFilterButtons.appendChild(taskFilterButton); const doneFilterButton = FilterButton.create( this._component, 'Done', 'check-square', this._settings.filter.includes('Done'), this.onFilterButton.bind(this), ); headerFilterButtons.appendChild(doneFilterButton); const deepHierarchyFilterButton = FilterButton.create( this._component, 'DeepHierarchy', 'gantt-chart', this._settings.filter.includes('DeepHierarchy'), this.onFilterButton.bind(this), ); headerFilterButtons.appendChild(deepHierarchyFilterButton); const maxDocuments = MaxShownModelsInput.create( this._component, this._settings.maxDocuments, this._IPrjSettings.defaultMaxShow, this.onMaxDocumentsChange.bind(this), ); headerFilterButtons.appendChild(maxDocuments); const searchBox = SearchInput.create( this._component, this.onSearch.bind(this), this._settings.searchText, ); headerFilterButtons.appendChild(searchBox); } /** * Add the documents to the table. * @param batchSize The size of the batch. * @param sleepBetweenBatches The time to sleep between batches. */ private async addDocumentsToTable( batchSize = this._settings.batchSize, sleepBetweenBatches = this._settings.sleepBetweenBatches, ): Promise<void> { let sleepPromise = Promise.resolve(); const modelsLength = this._models.length; const rows: Row[] = []; let rowPromise: Promise<Row> | undefined = undefined; if (modelsLength > 0) { rowPromise = this.generateTableRow(this._models[0]); } else { return; } let visibleRows = 0; for (let i = 0; i < modelsLength; i++) { const model = i + 1 < modelsLength ? this._models[i + 1] : null; const row = await rowPromise; rowPromise = model ? this.generateTableRow(model) : undefined; Iif (row && !row.hidden) { if (visibleRows < this._settings.maxDocuments) { visibleRows++; } else { row.hidden = true; } } Iif (row) rows.push(row); Iif ((i !== 0 && i % batchSize === 0) || i === modelsLength - 1) { await sleepPromise; this._table.addRows(rows); rows.length = 0; sleepPromise = HelperGeneral.sleep(sleepBetweenBatches); } } } /** * Generate a table row for a model. * @param model The model to generate the row for. * @returns The generated row. */ private async generateTableRow( model: PrjTaskManagementModel< IPrjTaskManagementData & PrjBaseData<unknown> >, ): Promise<Row> { const rowClassList: string[] = []; const rowData: DocumentFragment[] = []; const rowUid = this.getUID(model); // Row 0 -- Metadata Link const metadataLink = document.createDocumentFragment(); rowData.push(metadataLink); GeneralComponents.createMetadataLink( metadataLink, this._component, model.file.path, model.data.type?.toString() as FileTypes, model.getCorospondingSymbol(), ); // Row 1 -- Trafic Light const traficLight = document.createDocumentFragment(); rowData.push(traficLight); ProjectComponents.createTraficLight(traficLight, model.urgency); // Row 2 -- Title & Description const titleAndSummary = document.createDocumentFragment(); rowData.push(titleAndSummary); ProjectComponents.createTitle( titleAndSummary, this._component, model.file.path, () => model.data.title ?? '', (value: string) => (model.data.title = value), ); const lineBreak = document.createElement('br'); titleAndSummary.appendChild(lineBreak); ProjectComponents.createSummary( titleAndSummary, this._component, model.data.description ?? '', (value: string) => (model.data.description = value), ); // Row 3 -- Priority const priority = document.createDocumentFragment(); rowData.push(priority); ProjectComponents.createPriority( priority, this._component, () => model.data.priority?.toString() ?? '0', (value: string) => (model.data.priority = value as unknown as Priority), ); // Row 4 -- Due Date const dueDate = document.createDocumentFragment(); rowData.push(dueDate); GeneralComponents.createCellDate( dueDate, this._component, Lng.gt('Due date'), this._IPrjSettings.dateFormat, () => model.data.due ?? 'na', (value: string) => (model.data.due = value), ); // Row 5 -- Status const status = document.createDocumentFragment(); rowData.push(status); ProjectComponents.createStatus( status, this._component, () => model.data.status?.toString() ?? 'Active', (value: string) => (model.data.status = value as unknown as StatusTypes), ); // Row 6 -- Tags const tags = document.createDocumentFragment(); rowData.push(tags); GeneralComponents.createCellTags( tags, this._component, model.data.tags?.primitiveOf() ?? [], ); const hide = this.getHideState(model, this._settings.maxDocuments); const row = { rowUid, rowData, rowClassList, hidden: hide, }; return row; } /** * Called when the search input changes or a filter is applied. * @param type The type of the filter. * @param status The status of the filter. */ private async onFilterButton(type: string, status: boolean): Promise<void> { if (this._settings.filter.includes(type as FilteredModels)) { this._settings.filter = this._settings.filter.filter( (v) => v !== type, ); } else { this._settings.filter.push(type as FilteredModels); } await this.onFilterDebounce(); } /** * Debounce the filter button. */ private async onFilterDebounce(): Promise<void> { clearTimeout(this._filterButtonDebounceTimer); this._filterButtonDebounceTimer = setTimeout(() => { this.onFilter(); }, 750); } /** * Called when the maximum documents to show changes. * @param maxDocuments The maximum documents to show. * @returns A promise that resolves when the maximum documents to show changes. */ private async onMaxDocumentsChange( maxDocuments: number, ): Promise<undefined> { this._settings.maxDocuments = maxDocuments; this.onFilter(); return undefined; } /** * Get the hide state of a model. * @param model The model to get the hide state for. * @param maxVisibleRows The maximum visible rows. * @returns Whether the model should be hidden. */ protected getHideState( model: PrjTaskManagementModel< IPrjTaskManagementData & PrjBaseData<unknown> >, maxVisibleRows: number | undefined, ): boolean { let searchResult = false; let maxRows = false; Iif ( !this._settings.filter.includes('Done') && model.data.status?.equals('Done') ) { return true; } Iif (this._settings.search) { const text = model.data.toString?.(); searchResult = this._settings.search.applySearchLogic(text ?? ''); } Iif (maxVisibleRows && maxVisibleRows > 0) { const rowStats = this._table.getRowStats(); maxRows = rowStats.visibleRows >= maxVisibleRows; } const hide = this.determineHideState(model) || this.determineTagHideState(model); if (searchResult && !hide) { return false; // Shows the document, if it is not hidden and the search was successful } else if (this._settings.search) { return true; // Hide the document, if the search was not successful and aplicable } else Iif (!searchResult) { return maxRows || hide; // Else the document is hidden, if the max rows are reached or the document type is hidden } return hide; // Standard-Verhalten } /** * Determine the hide state of a model. * @param model The model to determine the hide state for. * @returns Whether the model should be hidden. */ private determineHideState( model: PrjTaskManagementModel< IPrjTaskManagementData & PrjBaseData<unknown> >, ): boolean { Iif ( this._settings.filter.includes('Topic') && model.data.type?.toString() === 'Topic' ) { return false; } Iif ( this._settings.filter.includes('Project') && model.data.type?.toString() === 'Project' ) { return false; } Iif ( this._settings.filter.includes('Task') && model.data.type?.toString() === 'Task' ) { return false; } return true; } /** * Determine the tag hide state of a model. * @param document The document to determine the tag hide state for. * @returns Whether the model should be hidden. */ private determineTagHideState( document: PrjTaskManagementModel< IPrjTaskManagementData & PrjBaseData<unknown> >, ): boolean { const settingTags = new Tags(this._settings.tags); if (this._settings.reactOnActiveFile) { return !document.data.tags?.contains(settingTags); } else if (this._settings.filter.includes('DeepHierarchy')) { return false; } else { return !document.data.tags?.areTagsAtHierarchyLevel(settingTags); } } /** * Called when the search input changes. */ public onActiveFileFilter(): void { this.onFilter(); } } /** * The types of models to show. * @remarks - `Topic` includes all topics. * - `Project` includes all projects. * - `Task` includes all tasks. * - `Done` includes all done tasks. * - `DeepHierarchy` includes all models that are below the active file. */ type FilteredModels = 'Topic' | 'Project' | 'Task' | 'Done' | 'DeepHierarchy'; |