@ihago.santos/fluentsql 1.0.0

package/index.js

@@ -0,0 +1,3 @@
+import FluentSQLBuilder from "./src/fluentSQL.js";
+
+export default FluentSQLBuilder;

package/jest.config.mjs

@@ -0,0 +1,203 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+
+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: "/private/var/folders/w0/tmhy86g10cb8k2883jbs63tm0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between 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: "coverage",
+
+  // 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: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: 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",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "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 between 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 between 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: "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: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // 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,
+};
+
+export default Object.assign({}, config);

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@ihago.santos/fluentsql",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "start": "node src/",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --config jest.config.mjs ",
+    "test:cov": "NODE_OPTIONS=--experimental-vm-modules npx jest --config jest.config.mjs --coverage ",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --config jest.config.mjs --watchAll "
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "jest": "^30.2.0"
+  }
+}

package/src/fluentSQL.js

@@ -0,0 +1,101 @@
+export default class FluentSQLBuilder {
+    #database = []
+    #limit = 0
+    #select = []
+    #where = []
+    #orderBy = ''
+
+    constructor({ database }) {
+        this.#database = database
+    }
+
+    static for(database) {
+        return new FluentSQLBuilder({ database })
+    }
+    limit(max) {
+        this.#limit = max
+
+        return this
+    }
+    select(props) {
+        this.#select = props
+
+        return this
+    }
+
+    where(query) {
+        // {category: 'developer'}
+        // {category: /dev/}
+
+
+        const [[prop, selectedValue]] = Object.entries(query)
+        const whereFilter = selectedValue instanceof RegExp ?
+            selectedValue :
+            new RegExp(selectedValue)
+
+        /*
+        [
+            [category, 'developer']
+        ]
+        */
+
+        this.#where.push({ prop, filter: whereFilter})
+
+        return this
+    }
+
+    orderBy(field) {
+        this.#orderBy = field
+        
+        return this
+    }
+    #performLimit(results) {
+        return this.#limit && results.length === this.#limit
+    }
+
+    #performWhere(item) {
+        for( const { filter, prop} of this.#where) {
+            if(!filter.test(item[prop])) return false
+        }
+
+        return true
+    }
+    #performSelect(item) { 
+        const currentItem = {}
+        const entries = Object.entries(item)
+        for(const [ key, value] of entries) {
+            if(this.#select.length && !this.#select.includes(key)) continue
+
+            currentItem[key] = value
+        }
+
+        return currentItem
+    }
+    #performOrderBy(results) { 
+        
+        if(!this.#orderBy) return results
+
+        return results.sort((prev, next) => {
+            return prev[this.#orderBy].localeCompare(next[this.#orderBy])
+        })
+
+    }   
+
+    build() {
+        const results = []
+        for (const item of this.#database) {
+            if (!this.#performWhere(item)) continue;
+
+            const currentItem = this.#performSelect(item)
+            results.push(currentItem)
+
+            if (this.#performLimit(results)) break;
+
+        }
+        
+
+        const finalResult = this.#performOrderBy(results)
+        return finalResult
+    }
+
+}

package/test/fluentSQL.test.js

@@ -0,0 +1,99 @@
+import { expect, describe, test } from '@jest/globals'
+import FluentSQLBuilder from '../src/fluentSQL'
+
+const data = [
+    {
+        id: 0,
+        name: 'erickwendel',
+        category: 'developer'
+    },
+    {
+        id: 1,
+        name: 'mariazinha',
+        category: 'developer'
+    },
+    {
+        id: 2,
+        name: 'joaozin',
+        category: 'manager'
+    },
+]
+
+describe('Test Suite for FluentSQL Builder', () => {
+    test('#for should return a FluentSQLBuilder instance', () => {
+        const result = FluentSQLBuilder.for(data)
+        const expected = new FluentSQLBuilder({ database: data })
+        expect(result).toStrictEqual(expected)
+    })
+    test('#build should return the empty object instance', () => {
+        const result = FluentSQLBuilder.for(data).build()
+        const expected = data
+        expect(result).toStrictEqual(expected)
+    })
+
+    test('#limit given a colletion it should limit results', () => {
+        const result = FluentSQLBuilder.for(data).limit(1).build()
+        const expected = [data[0]]
+
+        expect(result).toStrictEqual(expected)
+    })
+    test('#where given a collection it should filter data', () => {
+        const result = FluentSQLBuilder.for(data)
+            .where({
+                category: /^dev/
+            })
+            .build()
+
+        const expected = data.filter(({ category }) => category.slice(0, 3) === 'dev')
+
+
+        expect(result).toStrictEqual(expected)
+    })
+    test('#select given a collection it should return only specifc fields', () => {
+        const result = FluentSQLBuilder.for(data)
+            .select(['name', 'category'])
+            .build()
+
+        const expected = data.map(({ name, category }) => ({ name, category }))
+
+        expect(result).toStrictEqual(expected)
+    })
+    test('#orderBy given a collection it should order results by field', () => {
+        const result = FluentSQLBuilder.for(data)
+            .orderBy('name')
+            .build()
+
+        const expected = [
+            {
+                id: 0,
+                name: 'erickwendel',
+                category: 'developer'
+            },
+            {
+                id: 2,
+                name: 'joaozin',
+                category: 'manager'
+            },
+            {
+                id: 1,
+                name: 'mariazinha',
+                category: 'developer'
+            },
+        ]
+
+        expect(result).toStrictEqual(expected)
+    })
+
+    test('pipeline', () => {
+        const result = FluentSQLBuilder.for(data)
+            .where({ category: "developer" })
+            .where({ name: /m/ })
+            .select(['name', 'category'])
+            .orderBy('name')
+
+            .build()
+
+        const expected = data.filter(({ id }) => id === 1).map(({ name, category }) => ({ name, category }))
+        expect(result).toStrictEqual(expected)
+    })
+})