@beauraines/sprint-tracker 0.6.1

package/src/getSprintDetails.js

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+
+const prompt = require('prompt-sync')({sigint:true});
+const {homedir} = require('os');
+const { database: db } = require('helpers')
+
+
+async function main() {
+	// TODO read from a config or CLI
+	let database = `${homedir}/projects/sprint-tracker/tracker.db`
+	
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+
+	let sprints = await db.query(database,`select id, sprint_name AS name from sprints where project_id = ${project_id};`)
+	
+	// FIXME - sprint_name isn't being displayed because the function is looking for name
+	console.log('If your sprint is not displayed, you will have to manually add it.')
+	let sprintId = promptForInput(sprints,'Enter the sprint id: ')
+
+	statement = `select
+    p.name,
+    s.sprint_name,
+    s.start_date,
+    s.end_date,
+    o.name AS outcome_name,
+    so.issue_count,
+    so.story_points,
+    so.notes,
+    o.description
+
+from
+    sprint_outcomes so
+    JOIN sprints s on s.id = so.sprint_id
+    JOIN outcomes o on o.id = so.outcome_id
+    JOIN projects p on p.id = s.project_id
+where
+--    p.id = 4 
+--    and sprint_name = 'ACDC 15'
+    p.id = ${project_id}
+	and s.id = ${sprintId}`
+    
+	let sprintDetails = await db.query(database,statement)
+	console.log(sprintDetails)
+
+	
+}
+
+main()
+
+function promptForInput(items,promptText) {
+	let id
+	for (const item of items) {
+		console.log(item.id, item.name)
+	}
+	while (!id) {
+		id = prompt(promptText) 
+	
+		// validate the response
+		if (!items.find(x => (x.id == id))) {
+			console.error('Invalid id')
+			id = null
+		}
+	}
+	return id
+}

package/utils/display.js

@@ -0,0 +1,68 @@
+const Table = require('cli-table3');
+
+/**
+ * Displays the sprint outcomes. A sprint outcome is a 
+ * 
+ * { sprint_id, outcome_id, issue_count, story_points, notes }
+ * 
+ * 
+ * @param {Array} outcomes the array of sprint outcome objects
+ */
+function sprintOutcomes(outcomes) {
+    let table = new Table({ 
+        head: ['Sprint ID', 'Sprint Name','Outcome Name','Issue Count','Story Points','Notes'] 
+    });
+    for (const outcome of outcomes) {
+        table.push([
+            outcome.sprint_id,
+            outcome.sprint_name,
+            outcome.outcome_name,
+            outcome.issue_count,
+            outcome.story_points,
+            outcome.notes
+        ])
+    }
+
+    console.log(table.toString());
+
+   
+}
+
+function sprintDetails(details) {
+    let table = new Table({
+        head: ['Name', 'Sprint Name','Start Date','End Date', 'Outcome', 'Issue Count','Story Points','Notes'] 
+    })
+    for (const detail of details) {
+        table.push([
+            detail.name,
+            detail.sprint_name,
+            detail.start_date,
+            detail.end_date,
+            detail.outcome_name,
+            detail.issue_count,
+            detail.story_points,
+            detail.notes
+        ])
+    }
+    console.log(table.toString());
+
+}
+
+function project(project) {
+    let table = new Table({})
+    for (const key in project) {
+        if (Object.hasOwnProperty.call(project, key)) {
+            const element = project[key];
+            table.push({
+                [key]: element
+            })
+        }
+    }
+    console.log(table.toString());
+}
+
+module.exports = {
+    project,
+    sprintDetails,
+    sprintOutcomes
+}

package/utils/input.js

@@ -0,0 +1,24 @@
+const prompt = require('prompt-sync')({sigint:true});
+
+function promptForInput(items,promptText) {
+	let id
+	for (const item of items) {
+		console.log(item.id, item.name)
+	}
+	while (!id) {
+		id = prompt(promptText) 
+	
+		// validate the response
+		if (!items.find(x => (x.id == id))) {
+			console.error('Invalid id')
+			id = null
+		}
+	}
+	return id
+}
+
+
+module.exports = {
+    prompt,
+    promptForInput
+}

package/utils/readConfig.js

@@ -0,0 +1,74 @@
+const fs = require('fs');
+const { helpers, database	} = require('helpers')
+
+/**
+ * Reads the specified config file
+ * 
+ * @param {string} configFile the fully qualified path and file name for the config file
+ * @returns {object} the configuration object
+ */
+readConfig = async (configFile) => {
+
+	let config
+	if ( await helpers.fileExists(configFile) ) {
+		config = fs.readFileSync(configFile,
+			{ encoding: 'utf8', flag: 'r' });
+		config = JSON.parse(config);
+	} else {
+		console.error(`Config file not found. You must create one using the config command`)
+		process.exit(1);
+	}
+	
+	return config
+}
+
+/**
+ * Validates the config file to ensure that it has all of the required properties specified. This 
+ * is only schema validation, it does not check if the properties are valid values or data types.
+ * 
+ * @param {string} configFile the fully qualified path and file name for the config file
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ * @throws {Configuration file not found}
+ * @throws {Invalid configuration file}
+ * @returns {boolean} 
+ */
+validateConfig = async (configFile, configProps) => {
+    if (! fs.existsSync(configFile) ) {
+        throw new Error('Configuration file not found')
+    }
+    let config
+    config = fs.readFileSync(configFile,
+        { encoding: 'utf8', flag: 'r' });
+    config = JSON.parse(config);
+    // Check for properties
+    let validConfig = true
+    for (key of configProps) {
+        validConfig = config[key] ? true : false
+    }
+
+    if (!validConfig) {
+        throw Error('Invalid configuration file')
+    }
+    return validConfig
+}
+
+/**
+ * Creates a boilerplate config file
+ * 
+ * @param {string} configFile the fully qualified path and file name for the config file
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ */
+createConfig = async (configFile,configProps) => {
+    let config = {}
+    for (key of configProps) {
+        config[key] = ''
+    }
+    fs.writeFileSync(configFile,JSON.stringify(config))
+}
+
+module.exports = {
+    readConfig,
+    createConfig
+}