update anitomy

.eslintrc.json

@@ -1,10 +1,11 @@
 {
   "env": {
     "node": true,
-    "es6": true
+    "es6": true,
+    "jest": true
   },
   "parserOptions": {
-    "ecmaVersion": 2016
+    "ecmaVersion": 2018
   },
   "plugins": [
     "prettier"

.github/workflows/nodejs.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [16.x, 20.x]
 
     steps:
       - uses: actions/checkout@v1

.gitignore

@@ -9,5 +9,5 @@ jsconfig.json
 .DS_Store
 .vs/
 package-lock.json
-yarn.lock
-debug.js
+debug.js
+.yarn

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

__tests__/anitomy.test.js

@@ -0,0 +1,147 @@
+const anitomy = require('../index.js')
+
+describe('anitomy-js', () => {
+  const fixture = require('./data.json')
+  const fixtureKeys = Object.keys(fixture)
+  const fixtureValues = fixtureKeys.map((key) => fixture[key])
+
+  // ========= parseSync tests =========
+  describe('parseSync', () => {
+    it.each(fixtureKeys)('should parse all anime filenames, one by one %s', (key) => {
+      const result = anitomy.parseSync(key)
+
+      expect(result).toEqual(fixture[key], `key: ${key}`)
+    })
+
+    it('should parse all anime filenames, all at once', () => {
+      expect(anitomy.parseSync(fixtureKeys)).toEqual(fixtureValues)
+    })
+
+    it('should parse anime filenames, ignoring episode number, title, file extension and release group', () => {
+      const parsed = anitomy.parseSync(fixtureKeys, {
+        parse_episode_title: false,
+        parse_episode_number: false,
+        parse_file_extension: false,
+        parse_release_group: false,
+      })
+
+      expect(parsed.length).toEqual(fixtureKeys.length)
+      parsed.forEach((anime) => {
+        expect(anime).not.toHaveProperty('episode_title')
+        // check episode_number_alt because anitomy still parsing
+        // some file's episode number even with parse_episode_number set to
+        // false
+        expect(anime).not.toHaveProperty('episode_number_alt')
+        expect(anime).not.toHaveProperty('file_extension')
+        expect(anime).not.toHaveProperty('release_group')
+      })
+    })
+
+    it('should ignore string', () => {
+      const parsed = anitomy.parseSync('[ANBU]_Princess_Lover!_-_01_[2048A39A].mkv', {
+        ignored_strings: ['!'],
+      })
+
+      expect(parsed.file_name).toEqual('[ANBU]_Princess_Lover_-_01_[2048A39A]')
+    })
+
+    it('should override default delimiters', () => {
+      const parsed = anitomy.parseSync(
+        "[chibi-Doki] Seikon no Qwaser - 13v0 (Uncensored Director's Cut) [988DB090].mkv",
+        { allowed_delimiters: '_.&+,|' },
+      )
+
+      expect(parsed).toEqual({
+        anime_title: "Seikon no Qwaser - 13v0 (Uncensored Director's Cut)",
+        file_checksum: '988DB090',
+        file_extension: 'mkv',
+        file_name: "[chibi-Doki] Seikon no Qwaser - 13v0 (Uncensored Director's Cut) [988DB090]",
+        release_group: 'chibi-Doki',
+      })
+    })
+
+    it('should throw an exception for wrong datatypes (files)', () => {
+      expect(() => anitomy.parseSync(1)).toThrow('Input must be either a string or array')
+    })
+
+    it('should use empty object as default options', () => {
+      expect(anitomy.parseSync('', null)).toEqual({})
+    })
+
+    it('should throw wrong number of arguments', () => {
+      expect(() => anitomy.parseSync()).toThrow('Input must be either a string or array')
+    })
+  })
+
+  // ========= parseAsync tests =========
+  describe('parseAsync', () => {
+    it.each(fixtureKeys)('should parse all anime filenames, one by one %s', async (key) => {
+      const result = await anitomy.parseAsync(key)
+
+      expect(result).toEqual(fixture[key], `key: ${key}`)
+    })
+
+    it('should parse all anime filenames, all at once', async () => {
+      const result = await anitomy.parseAsync(fixtureKeys)
+
+      return expect(result).toEqual(fixtureValues)
+    })
+
+    it('should parse anime filenames, ignoring episode number, title, file extension and release group', async () => {
+      const options = {
+        parse_episode_title: false,
+        parse_episode_number: false,
+        parse_file_extension: false,
+        parse_release_group: false,
+      }
+
+      const parsed = await anitomy.parseAsync(fixtureKeys, options)
+
+      expect(parsed.length).toEqual(fixtureKeys.length)
+      parsed.forEach(function (anime) {
+        expect(anime).not.toHaveProperty('episode_title')
+        // check episode_number_alt because anitomy still parsing
+        // some file's episode number even with parse_episode_number set to
+        // false
+        expect(anime).not.toHaveProperty('episode_number_alt')
+        expect(anime).not.toHaveProperty('file_extension')
+        expect(anime).not.toHaveProperty('release_group')
+      })
+    })
+
+    it('should ignore string', async () => {
+      const options = { ignored_strings: ['!'] }
+      const input = '[ANBU]_Princess_Lover!_-_01_[2048A39A].mkv'
+
+      const result = await anitomy.parseAsync(input, options)
+
+      return expect(result).toMatchObject({
+        file_name: '[ANBU]_Princess_Lover_-_01_[2048A39A]',
+      })
+    })
+
+    it('should override default delimiters', async () => {
+      // eslint-disable-next-line prettier/prettier
+      const input = "[chibi-Doki] Seikon no Qwaser - 13v0 (Uncensored Director's Cut) [988DB090].mkv"
+      const options = { allowed_delimiters: '_.&+,|' }
+
+      const result = await anitomy.parseAsync(input, options)
+
+      return expect(result).toEqual({
+        anime_title: "Seikon no Qwaser - 13v0 (Uncensored Director's Cut)",
+        file_checksum: '988DB090',
+        file_extension: 'mkv',
+        file_name: "[chibi-Doki] Seikon no Qwaser - 13v0 (Uncensored Director's Cut) [988DB090]",
+        release_group: 'chibi-Doki',
+      })
+    })
+
+    it('should throw an exception for wrong datatypes (files)', async () => {
+      await expect(anitomy.parseAsync(1)).rejects.toThrow('Input must be either a string or array')
+    })
+
+    it('should not throw and return empty object', async () => {
+      return expect(anitomy.parseAsync('', null)).resolves.toEqual({})
+    })
+  })
+})

jest.config.js

@@ -0,0 +1,198 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+module.exports = config;