Add exemplar analyzers (#84)

Author: SleeplessByte

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.12.0
+
+- Add generic ExemplarAnalyzer
+- Use generic ExemplarAnalyzer for `annalyns-infiltration`
+- Use generic ExemplarAnalyzer for `freelancer-rates`
+
 ## 0.11.2
 
 - Improve `concept/lasagna` analysis

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exercism/javascript-analyzer",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "Exercism analyzer for javascript",
   "repository": "https://github.com/exercism/javascript-analyzer",
   "author": "Derk-Jan Karrenbeld <[email protected]>",

src/analyzers/concept/__exemplar/ExemplarSolution.ts

@@ -0,0 +1,44 @@
+import {
+  AstParser,
+  extractExports,
+  extractFunctions,
+} from '@exercism/static-analysis'
+import { TSESTree } from '@typescript-eslint/typescript-estree'
+import { readFileSync } from 'fs'
+import path from 'path'
+import { Source } from '../../SourceImpl'
+
+export class ExemplarSolution {
+  private readonly source: Source
+
+  private exemplar!: Source
+
+  constructor(public readonly program: TSESTree.Program, source: string) {
+    this.source = new Source(source)
+
+    const functions = extractFunctions(program)
+    const exports = extractExports(program)
+  }
+
+  public readExemplar(directory: string): void {
+    const configPath = path.join(directory, '.meta', 'config.json')
+    const config = JSON.parse(readFileSync(configPath).toString())
+
+    const exemplarPath = path.join(directory, config.files.exemplar[0])
+    this.exemplar = new Source(readFileSync(exemplarPath).toString())
+  }
+
+  public get isExemplar(): boolean {
+    const sourceAst = AstParser.REPRESENTER.parseSync(this.source.toString())
+    const exemplarAst = AstParser.REPRESENTER.parseSync(
+      this.exemplar.toString()
+    )
+
+    // TODO: ignore order of exports, if possible/hoisted
+
+    return (
+      JSON.stringify(sourceAst[0].program) ===
+      JSON.stringify(exemplarAst[0].program)
+    )
+  }
+}

src/analyzers/concept/__exemplar/index.ts

@@ -0,0 +1,61 @@
+import {
+  AstParser,
+  Input,
+  NoExportError,
+  NoMethodError,
+} from '@exercism/static-analysis'
+import { TSESTree } from '@typescript-eslint/typescript-estree'
+import { ExecutionOptions, WritableOutput } from '~src/interface'
+import {
+  EXEMPLAR_SOLUTION,
+  NO_METHOD,
+  NO_NAMED_EXPORT,
+} from '../../../comments/shared'
+import { IsolatedAnalyzerImpl } from '../../IsolatedAnalyzerImpl'
+import { ExemplarSolution } from './ExemplarSolution'
+
+type Program = TSESTree.Program
+
+export class ExemplarAnalyzer extends IsolatedAnalyzerImpl {
+  private solution!: ExemplarSolution
+
+  protected async execute(
+    input: Input,
+    output: WritableOutput,
+    options: ExecutionOptions
+  ): Promise<void> {
+    const [parsed] = await AstParser.ANALYZER.parse(input)
+
+    this.solution = this.checkStructure(parsed.program, parsed.source, output)
+    this.solution.readExemplar(options.inputDir)
+
+    if (this.solution.isExemplar) {
+      output.add(EXEMPLAR_SOLUTION())
+      output.finish()
+    }
+
+    output.finish()
+  }
+
+  private checkStructure(
+    program: Readonly<Program>,
+    source: Readonly<string>,
+    output: WritableOutput
+  ): ExemplarSolution | never {
+    try {
+      return new ExemplarSolution(program, source)
+    } catch (error) {
+      if (error instanceof NoMethodError) {
+        output.add(NO_METHOD({ 'method.name': error.method }))
+        output.finish()
+      }
+
+      if (error instanceof NoExportError) {
+        output.add(NO_NAMED_EXPORT({ 'export.name': error.namedExport }))
+        output.finish()
+      }
+
+      throw error
+    }
+  }
+}

src/analyzers/concept/annalyns-infiltration/index.ts

@@ -0,0 +1,5 @@
+import { ExemplarAnalyzer } from '../__exemplar'
+
+export class AnnalynsInfiltrationAnalyzer extends ExemplarAnalyzer {
+  // TODO: implement actual analyzer
+}

src/analyzers/concept/freelancer-rates/index.ts

@@ -0,0 +1,5 @@
+import { ExemplarAnalyzer } from '../__exemplar'
+
+export class FreelancerRatesAnalyzer extends ExemplarAnalyzer {
+  // TODO: implement actual analyzer
+}

test/analyzers/annalyns-infiltration/exemplar.ts

@@ -0,0 +1,41 @@
+import path from 'path'
+import { AnnalynsInfiltrationAnalyzer } from '~src/analyzers/concept/annalyns-infiltration'
+import { EXEMPLAR_SOLUTION } from '~src/comments/shared'
+import { DirectoryWithConfigInput } from '~src/input/DirectoryWithConfigInput'
+import { makeAnalyze, makeOptions } from '~test/helpers/smoke'
+
+const inputDir = path.join(
+  __dirname,
+  '..',
+  '..',
+  'fixtures',
+  'annalyns-infiltration',
+  'exemplar'
+)
+
+const analyze = makeAnalyze(
+  () => new AnnalynsInfiltrationAnalyzer(),
+  makeOptions({
+    get inputDir(): string {
+      return inputDir
+    },
+    get exercise(): string {
+      return 'annalyns-infiltration'
+    },
+  })
+)
+
+describe('When running analysis on annalyns-infiltration', () => {
+  it('recognises the exemplar solution', async () => {
+    const input = new DirectoryWithConfigInput(inputDir)
+
+    const [solution] = await input.read()
+    const output = await analyze(solution)
+
+    expect(output.comments.length).toBe(1)
+    expect(output.comments[0].type).toBe('celebratory')
+    expect(output.comments[0].externalTemplate).toBe(
+      EXEMPLAR_SOLUTION().externalTemplate
+    )
+  })
+})

test/analyzers/freelancer-rates/exemplar.ts

@@ -0,0 +1,41 @@
+import path from 'path'
+import { FreelancerRatesAnalyzer } from '~src/analyzers/concept/freelancer-rates'
+import { EXEMPLAR_SOLUTION } from '~src/comments/shared'
+import { DirectoryWithConfigInput } from '~src/input/DirectoryWithConfigInput'
+import { makeAnalyze, makeOptions } from '~test/helpers/smoke'
+
+const inputDir = path.join(
+  __dirname,
+  '..',
+  '..',
+  'fixtures',
+  'freelancer-rates',
+  'exemplar'
+)
+
+const analyze = makeAnalyze(
+  () => new FreelancerRatesAnalyzer(),
+  makeOptions({
+    get inputDir(): string {
+      return inputDir
+    },
+    get exercise(): string {
+      return 'freelancer-rates'
+    },
+  })
+)
+
+describe('When running analysis on freelancer-rates', () => {
+  it('recognises the exemplar solution', async () => {
+    const input = new DirectoryWithConfigInput(inputDir)
+
+    const [solution] = await input.read()
+    const output = await analyze(solution)
+
+    expect(output.comments.length).toBe(1)
+    expect(output.comments[0].type).toBe('celebratory')
+    expect(output.comments[0].externalTemplate).toBe(
+      EXEMPLAR_SOLUTION().externalTemplate
+    )
+  })
+})

test/analyzers/lasagna/exemplar.ts

@@ -0,0 +1,41 @@
+import path from 'path'
+import { LasagnaAnalyzer } from '~src/analyzers/concept/lasagna'
+import { EXEMPLAR_SOLUTION } from '~src/comments/shared'
+import { DirectoryWithConfigInput } from '~src/input/DirectoryWithConfigInput'
+import { makeAnalyze, makeOptions } from '~test/helpers/smoke'
+
+const inputDir = path.join(
+  __dirname,
+  '..',
+  '..',
+  'fixtures',
+  'lasagna',
+  'exemplar'
+)
+
+const analyze = makeAnalyze(
+  () => new LasagnaAnalyzer(),
+  makeOptions({
+    get inputDir(): string {
+      return inputDir
+    },
+    get exercise(): string {
+      return 'lasagna'
+    },
+  })
+)
+
+describe('When running analysis on lasagna', () => {
+  it('recognises the exemplar solution', async () => {
+    const input = new DirectoryWithConfigInput(inputDir)
+
+    const [solution] = await input.read()
+    const output = await analyze(solution)
+
+    expect(output.comments.length).toBe(1)
+    expect(output.comments[0].type).toBe('celebratory')
+    expect(output.comments[0].externalTemplate).toBe(
+      EXEMPLAR_SOLUTION().externalTemplate
+    )
+  })
+})

test/fixtures/annalyns-infiltration/exemplar/.meta/config.json

@@ -0,0 +1,25 @@
+{
+  "blurb": "TODO: add blurb for booleans exercise",
+  "authors": [
+    {
+      "github_username": "ovidiu141",
+      "exercism_username": "ovidiu141"
+    }
+  ],
+  "contributors": [
+    {
+      "github_username": "rishiosaur",
+      "exercism_username": "rishiosaur"
+    },
+    {
+      "github_username": "SleeplessByte",
+      "exercism_username": "SleeplessByte"
+    }
+  ],
+  "files": {
+    "solution": ["annalyns-infiltration.js"],
+    "test": ["annalyns-infiltration.spec.js"],
+    "exemplar": [".meta/exemplar.js"]
+  },
+  "forked_from": []
+}