-
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#20 moved .env .ini and .properties data loading to new properties.da…
…ta.provider.ts impl.
- Loading branch information
1 parent
957c1f3
commit dc80f59
Showing
3 changed files
with
105 additions
and
36 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| import {window} from 'vscode'; | ||
| import * as props from 'properties'; | ||
| import * as config from '../config'; | ||
| import * as fileUtils from '../utils/file.utils'; | ||
| import * as jsonUtils from '../utils/json.utils'; | ||
| import {Logger, LogLevel} from '../logger'; | ||
| import {IDataProvider} from '../data.manager'; | ||
|
|
||
| /** | ||
| * Properties data provider for .properties, .ini and .env data files. | ||
| */ | ||
| export class PropertiesDataProvider implements IDataProvider { | ||
|
|
||
| // TODO: add mime types later for http data loading | ||
| public supportedDataFileTypes: Array<string> = ['.env', '.ini', '.properties']; | ||
|
|
||
| private logger: Logger = new Logger('properties.data.provider:', config.logLevel); | ||
|
|
||
| /** | ||
| * Creates new properties data provider for .env, .ini, and .properties config files. | ||
| */ | ||
| constructor() { | ||
| this.logger.debug('created for:', this.supportedDataFileTypes); | ||
| } | ||
|
|
||
| /** | ||
| * Gets local or remote data. | ||
| * @param dataUrl Local data file path or remote data url. | ||
| * @param parseOptions Data parse options. | ||
| * @param loadData Load data callback. | ||
| */ | ||
| public getData(dataUrl: string, parseOptions: any, loadData: Function): void { | ||
| let data: any = []; | ||
| // TODO: add mime types later for remote http data loading | ||
| const dataFileType: string = dataUrl.substr(dataUrl.lastIndexOf('.')); // file extension | ||
| try { | ||
| // read and parse properties file type data | ||
| let content: string = fileUtils.readDataFile(dataUrl, 'utf8'); | ||
| data = props.parse(content, this.getDataParseOptions(dataFileType)); | ||
| } | ||
| catch (error) { | ||
| this.logger.logMessage(LogLevel.Error, `getData(): Error parsing '${dataUrl}' \n\t Error:`, error.message); | ||
| window.showErrorMessage(`Unable to parse data file: '${dataUrl}'. \n\t Error: ${error.message}`); | ||
| } | ||
| loadData(jsonUtils.convertJsonData(data)); | ||
| } | ||
|
|
||
| /** | ||
| * Gets data provider parse options for the specified data file type. | ||
| * @param dataFileType Data file type. | ||
| */ | ||
| private getDataParseOptions(dataFileType: string): Function { | ||
| let dataParseOptions: any = null; // default | ||
| switch (dataFileType) { | ||
| case '.env': | ||
| dataParseOptions = {sections: true, comments: ['#']}; | ||
| break; | ||
| case '.ini': | ||
| // NOTE: some INI files consider # as a comment | ||
| dataParseOptions = {sections: true, comments: [';', '#']}; | ||
| break; | ||
| case '.properties': | ||
| dataParseOptions = {sections: true}; | ||
| break; | ||
| } | ||
| return dataParseOptions; | ||
| } | ||
|
|
||
| /** | ||
| * Gets data table names for data sources with multiple data sets. | ||
| * @param dataUrl Local data file path or remote data url. | ||
| */ | ||
| public getDataTableNames(dataUrl: string): Array<string> { | ||
| return []; // none for properties data files | ||
| } | ||
|
|
||
| /** | ||
| * Gets data schema in json format for file types that provide it. | ||
| * @param dataUrl Local data file path or remote data url. | ||
| */ | ||
| public getDataSchema(dataUrl: string): any { | ||
| // TODO: auto-gen json schema ??? | ||
| return null; // none for properties data files | ||
| } | ||
|
|
||
| /** | ||
| * Saves raw Data Provider data. | ||
| * @param filePath Data file path. | ||
| * @param fileData Raw data to save. | ||
| * @param stringifyFunction Optional stringiy function override. | ||
| */ | ||
| public saveData(filePath: string, fileData: any, stringifyFunction: Function): void { | ||
| // TODO | ||
| } | ||
| } |