setup position/progress/tutorial context

Author: ShMcK

src/channel/state/Position.ts

@@ -0,0 +1,63 @@
+import * as CR from 'typings'
+import * as G from 'typings/graphql'
+
+// position
+class Position {
+	private value: CR.Position
+	constructor() {
+		this.value = {
+			levelId: '',
+			stageId: '',
+			stepId: '',
+		}
+	}
+	public get = () => {
+		return this.value
+	}
+	public set = (value: CR.Position) => {
+		this.value = value
+	}
+	// calculate the current position based on the saved progress
+	public setPositionFromProgress = (tutorial: G.Tutorial, progress: CR.Progress): CR.Position => {
+
+		// tutorial already completed
+		// TODO: handle start again?
+		if (progress.complete) {
+			return this.value
+		}
+
+		const {levels} = tutorial.version
+
+		const lastLevelIndex: number | undefined = levels.findIndex((l: G.Level) => progress.levels[l.id])
+		// TODO: consider all levels complete as progress.complete
+		if (lastLevelIndex < 0 && lastLevelIndex < levels.length) {
+			throw new Error('Error setting progress level')
+		}
+		const currentLevel: G.Level = levels[lastLevelIndex + 1]
+
+		const {stages} = currentLevel
+
+		const lastStageIndex: number | undefined = stages.findIndex((s: G.Stage) => progress.stages[s.id])
+		if (lastStageIndex < 0 && lastStageIndex < stages.length) {
+			throw new Error('Error setting progress stage')
+		}
+		const currentStage: G.Stage = stages[lastStageIndex + 1]
+
+		const {steps} = currentStage
+
+		const lastStepIndex: number | undefined = steps.findIndex((s: G.Step) => progress.steps[s.id])
+		if (lastStepIndex < 0 && lastStepIndex < steps.length) {
+			throw new Error('Error setting progress step')
+		}
+		const currentStep: G.Step = steps[lastStepIndex + 1]
+
+		this.value = {
+			levelId: currentLevel.id,
+			stageId: currentStage.id,
+			stepId: currentStep.id,
+		}
+		return this.value
+	}
+}
+
+export default Position

src/channel/state/Progress.ts

@@ -0,0 +1,42 @@
+import * as CR from 'typings'
+import * as G from 'typings/graphql'
+import * as vscode from 'vscode'
+
+import Storage from '../../services/storage'
+
+const defaultValue = {
+	levels: {},
+	stages: {},
+	steps: {},
+	complete: false
+}
+
+// hold current progress and sync to storage based on tutorial.id/version
+class Progress {
+	private value: CR.Progress
+	private storage: Storage<CR.Progress> | undefined
+	constructor() {
+		this.value = defaultValue
+	}
+	public setTutorial = (workspaceState: vscode.Memento, tutorial: G.Tutorial) => {
+		this.storage = new Storage<CR.Progress>({
+			key: `coderoad:progress:${tutorial.id}:${tutorial.version}`,
+			storage: workspaceState,
+			defaultValue,
+		})// set value from storage
+		this.storage.get().then((value: CR.Progress) => {
+			this.value = value
+		})
+	}
+	public get = () => {
+		return this.value
+	}
+	public set = (value: CR.Progress) => {
+		this.value = value
+		if (this.storage) {
+			this.storage.set(value)
+		}
+	}
+}
+
+export default Progress

src/channel/state/Tutorial.ts

@@ -0,0 +1,30 @@
+import * as G from 'typings/graphql'
+import * as vscode from 'vscode'
+
+import Storage from '../../services/storage'
+
+// Tutorial
+class Tutorial {
+	private storage: Storage<G.Tutorial | null>
+	private value: G.Tutorial | null
+	constructor(workspaceState: vscode.Memento) {
+		this.storage = new Storage<G.Tutorial | null>({
+			key: 'coderoad:currentTutorial',
+			storage: workspaceState,
+			defaultValue: null
+		})
+		this.value = null
+		// set value from storage
+		this.storage.get().then((value: G.Tutorial | null) => {
+			this.value = value
+		})
+	}
+	public get = () => {
+		return this.value
+	}
+	public set = (value: G.Tutorial) => {
+		this.value = value
+	}
+}
+
+export default Tutorial