Merge pull request #1 from ioncakephper/chore/add-core-functions

Author: ioncakephper

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+*Changelog created using the [Simple Changelog](https://marketplace.visualstudio.com/items?itemName=tobiaswaelde.vscode-simple-changelog) extension for VS Code.*

index.js

@@ -0,0 +1 @@
+return require('./src/source-processor');

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: "C:\\Users\\ig343\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // 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;

package-lock.json

@@ -24,9 +24,10 @@
   },
   "homepage": "https://github.com/ioncakephper/insert-file-tag#readme",
   "scripts": {
-    "test": "jest --passWithNoTests"
+    "test": "jest"
   },
   "dependencies": {
+    "fs": "^0.0.1-security",
     "fs-extra": "^11.1.1"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,41 @@
+const fs = require('fs');
+const path = require('path');
+const { processFilename } = require('./source-processor');
+
+describe('processFilename', () => {
+  it('throws an error when no filename is provided', () => {
+    expect(() => processFilename()).toThrow(Error);
+  });
+
+  it('throws a TypeError when the filename is not a string', () => {
+    expect(() => processFilename(123)).toThrow(TypeError);
+  });
+
+  it('returns null when the file does not exist', () => {
+    const filename = 'non-existent-file.txt';
+    expect(processFilename(filename)).toBeNull();
+  });
+
+  it('returns null when the file is empty', () => {
+    const filename = 'empty-file.txt';
+    fs.writeFileSync(filename, '');
+    expect(processFilename(filename)).toBeNull();
+    fs.unlinkSync(filename);
+  });
+
+  it('processes the markdown content correctly when the file exists and is not empty', () => {
+    const filename = 'test-file.txt';
+    const fileContent = 'This is a test file.';
+    fs.writeFileSync(filename, fileContent);
+    const result = processFilename(filename);
+    expect(result).toContain(fileContent);
+    fs.unlinkSync(filename);
+  });
+
+//   it('throws an error when an error occurs while reading the file', () => {
+//     const filename = 'test-file.txt';
+//     fs.chmodSync(filename, 0o000); // make the file unreadable
+//     expect(() => processFilename(filename)).toThrow(Error);
+//     fs.chmodSync(filename, 0o644); // restore the file permissions
+//   });
+});

src/processFilename.test.js

@@ -0,0 +1,46 @@
+const fs = require('fs');
+const path = require('path');
+const {processSourceCode} = require('./source-processor');
+
+describe('processSourceCode', () => {
+  it('throws TypeError when sourceCode is not a string', () => {
+    expect(() => processSourceCode(123)).toThrow(TypeError);
+  });
+
+  it('replaces insert/include tags with file content', () => {
+    const sourceCode = '<!-- ::insert file="test.txt" --><!-- :/insert -->';
+    const basePath = './test';
+    const fileContent = 'Hello World!';
+    const filename = path.join(basePath, 'test.txt');
+    fs.mkdirSync(path.dirname(filename), { recursive: true });
+    fs.writeFileSync(path.join(basePath, 'test.txt'), fileContent, 'utf8');
+    const result = processSourceCode(sourceCode, basePath);
+    expect(result).toContain(fileContent);
+    fs.unlinkSync(path.join(basePath, 'test.txt'));
+  });
+
+//   it('handles missing file paths in tags', () => {
+//     const sourceCode = '<!-- ::insert --><!-- :/insert -->';
+//     const basePath = './test';
+//     fs.mkdirSync(path.join(basePath), { recursive: true });
+//     const result = processSourceCode(sourceCode, basePath);
+//     expect(result).toContain('<!-- Error: missing file path -->');
+//   });
+
+  it('handles errors when reading files', () => {
+    const sourceCode = '<!-- ::insert file="non-existent.txt" --><!-- :/insert -->';
+    const basePath = './test';
+    const result = processSourceCode(sourceCode, basePath);
+    expect(result).toContain('<!-- Error processing file: non-existent.txt -->');
+  });
+
+  it('resolves file paths relative to the provided base path', () => {
+    const sourceCode = '<!-- ::insert file="test.txt" --><!-- :/insert -->';
+    const basePath = './test/subdir';
+    const fileContent = 'Hello World!';
+    fs.writeFileSync(path.join(basePath, 'test.txt'), fileContent);
+    const result = processSourceCode(sourceCode, basePath);
+    expect(result).toContain(fileContent);
+    fs.unlinkSync(path.join(basePath, 'test.txt'));
+  });
+});