Merge pull request #228 from beakerandjake/feature/224-number-of-solvable-probles-is-49-not-50

Feature/224 number of solvable probles is 49 not 50

Author: beakerandjake

.eslintignore

@@ -1 +1,2 @@
-jest.config.mjs
+jest.config.mjs
+templates/

.eslintrc.cjs

@@ -29,5 +29,6 @@ module.exports = {
       // ignore false positive when importing v11.1.0
       { ignore: ['fs-extra/esm'] },
     ],
+    'no-plusplus':'off'
   },
 };

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Added support for 2023 to the config file ([#226](https://github.com/beakerandjake/advent-of-code-runner/issues/226))
+### Fixed
+- Fix number of solvable problems to be 49 not 50 (day 25 only has one level) ([#224](https://github.com/beakerandjake/advent-of-code-runner/issues/224))
+
 
 ## [1.3.6] - 2023-08-23
 ### Fixed

src/actions/assertPuzzleHasLevel.js

@@ -0,0 +1,16 @@
+import { logger } from '../logger.js';
+import { getAllPuzzlesForYear } from '../validation/validatePuzzle.js';
+
+/**
+ * Asserts that the days puzzle has the level.
+ * All days have two levels except for the last day which has one.
+ */
+export const assertPuzzleHasLevel = ({ year, day, level } = {}) => {
+  const hasLevel = getAllPuzzlesForYear(year).some(
+    (x) => x.level === level && x.day === day
+  );
+  if (!hasLevel) {
+    logger.error(`Day ${day} does not have level ${level}.`);
+  }
+  return hasLevel;
+};

src/actions/index.js

@@ -2,6 +2,7 @@ import { assertAnswerCorrect } from './assertAnswerCorrect.js';
 import { assertAnswerNotPreviouslySubmitted } from './assertAnswerNotPreviouslySubmitted.js';
 import { assertConfigValue } from './assertConfigValue.js';
 import { assertInitialized } from './assertInitialized.js';
+import { assertPuzzleHasLevel } from './assertPuzzleHasLevel.js';
 import { assertPuzzleLevelMet } from './assertPuzzleLevelMet.js';
 import { assertPuzzleUnlocked } from './assertPuzzleUnlocked.js';
 import { assertPuzzleUnsolved } from './assertPuzzleUnsolved.js';
@@ -37,6 +38,7 @@ export {
   assertInitialized,
   assertPuzzleUnlocked,
   assertPuzzleUnsolved,
+  assertPuzzleHasLevel,
   assertPuzzleLevelMet,
   assertUserConfirmation,
   executeUserSolution,

src/cli/initialize.js

@@ -40,7 +40,7 @@ const initializeQuestions = [
     name: 'year',
     message: festiveStyle('What year of advent of code are you doing?'),
     prefix: festiveEmoji(),
-    choices: getConfigValue('aoc.validation.years')?.reverse(),
+    choices: [...getConfigValue('aoc.validation.years')].reverse(),
     loop: false,
   },
   authTokenQuestion,

src/cli/solve.js

@@ -7,6 +7,7 @@ import { dayArgument, levelArgument } from './arguments.js';
  * The common actions between the 'solve' and 'autosolve' commands
  */
 const solveActions = [
+  actions.assertPuzzleHasLevel,
   actions.outputPuzzleLink,
   actions.assertPuzzleUnlocked,
   actions.assertPuzzleLevelMet,

src/cli/submit.js

@@ -7,6 +7,7 @@ import { dayArgument, levelArgument } from './arguments.js';
  * The common actions between the 'submit' and 'autosubmit' commands
  */
 const submitActions = [
+  actions.assertPuzzleHasLevel,
   actions.outputPuzzleLink,
   actions.assertPuzzleUnlocked,
   actions.assertPuzzleLevelMet,

src/config.js

@@ -153,7 +153,13 @@ const CONFIG = {
         source: join(__dirname, '..', 'templates', 'template-dataFile.json'),
         dest: join(cwd, 'aocr-data.json'),
       },
-      solution: join(__dirname, '..', 'templates', 'template-solution.js'),
+      solutionDefault: join(__dirname, '..', 'templates', 'template-solution.js'),
+      solutionLastDay: join(
+        __dirname,
+        '..',
+        'templates',
+        'template-solution-last-day.js'
+      ),
     },
   },
   initialize: {

src/initialize/createSolutionFiles.js

@@ -13,6 +13,21 @@ const tokens = [
   { match: '{{year}}', key: 'year' },
 ];
 
+/**
+ * Create a solution template for each day.
+ * @param {String} template
+ * @param {Number[]} days
+ * @returns {Array<Promise>}
+ */
+const doCreate = (template, year, days) =>
+  days.map((day) =>
+    writeFile(
+      getSolutionFileName(day),
+      replaceTokens(tokens, { year, day }, template),
+      'utf-8'
+    )
+  );
+
 /**
  * Creates the solution files in the cwd.
  */
@@ -23,24 +38,19 @@ export const createSolutionFiles = async ({ year } = {}) => {
     throw new Error('null or undefined year');
   }
 
-  // create directory if doesn't exist.
-  const solutionsDir = getConfigValue('paths.solutionsDir');
-  await ensureDir(solutionsDir);
+  // create solution dir if does not already exist.
+  await ensureDir(getConfigValue('paths.solutionsDir'));
 
-  // load the contents of the template solution
-  const templateSolutionFile = await readFile(
-    getConfigValue('paths.templates.solution'),
-    { encoding: 'utf-8' }
-  );
-
-  // create each template solution file.
-  const createFilePromises = getConfigValue('aoc.validation.days').map((day) =>
-    writeFile(
-      getSolutionFileName(day),
-      replaceTokens(tokens, { year, day }, templateSolutionFile),
-      'utf-8'
-    )
-  );
+  // load the template files (last day is special and needs a different template than default)
+  const [basicTemplate, lastDayTemplate] = await Promise.all([
+    readFile(getConfigValue('paths.templates.solutionDefault'), 'utf8'),
+    readFile(getConfigValue('paths.templates.solutionLastDay'), 'utf8'),
+  ]);
 
-  await Promise.all(createFilePromises);
+  return Promise.all([
+    // all days but the last day share a default solution template.
+    ...doCreate(basicTemplate, year, getConfigValue('aoc.validation.days').slice(0, -1)),
+    // last day is special and needs a different solution template.
+    ...doCreate(lastDayTemplate, year, getConfigValue('aoc.validation.days').slice(-1)),
+  ]);
 };