@trojs/mutator 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TroJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# Mutate the value when set some data
+
+[![NPM version][npm-image]][npm-url] [![Coveralls Status][coveralls-image]][coveralls-url]
+
+With this package you can define some setters that are optional.
+So it change the value for the defined setters, but if you don't pass the key, it doesnt set the key.
+
+## Installation
+
+`npm install @trojs/objects`
+or
+`yarn add @trojs/objects`
+
+## Test the package
+
+`npm run test`
+or
+`yarn test`
+
+## Example usage
+
+```javascript
+import DefaultMutator from '@trojs/mutator'
+
+class ExampleMutator extends DefaultMutator {
+  setSkuAttribute (sku) {
+    return `*${sku}*`
+  }
+}
+
+const result = ExampleMutator.create({ sku: '42', test: 'ok' })
+{
+    sku: '*42*',
+    test: 'ok'
+}
+
+const result = ExampleMutator.create({ sku: '42' })
+{
+    sku: '*42*'
+}
+
+const result = ExampleMutator.create({ test: 'ok' })
+{
+    test: 'ok'
+}
+```
+
+You can also hydrate the object with new data
+
+```javascript
+const result = ExampleMutator.create({ test: 'ok', test2: 'also ok' })
+{
+    test: 'ok',
+    test2: 'also ok'
+}
+
+result.hydrate({ sku: 43})
+{
+    test: 'ok',
+    test2: 'also ok',
+    sku: '*43*'
+}
+
+result.hydrate({ test: 'another text'})
+{
+    test: 'another text',
+    test2: 'also ok',
+    sku: '*43*'
+}
+```
+
+[npm-url]: https://www.npmjs.com/package/@trojs/mutator
+[npm-image]: https://img.shields.io/npm/v/@trojs/mutator.svg
+[coveralls-url]: https://coveralls.io/r/hckrnews/mutator
+[coveralls-image]: https://img.shields.io/coveralls/hckrnews/mutator/main.svg

package/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@trojs/mutator",
+    "description": "Mutate the value when set some data",
+    "version": "0.4.0",
+    "author": {
+        "name": "Pieter Wigboldus",
+        "url": "https://trojs.org/"
+    },
+    "license": "MIT",
+    "scripts": {
+        "lint": "eslint src/*.js --config .eslintrc",
+        "lint:fix": "eslint src/*.js --config .eslintrc --fix",
+        "lint:report": "eslint src/*.js --config .eslintrc -f json -o report.json",
+        "test": "jest",
+        "test:watch": "jest src --watch",
+        "coveralls": "jest && codecov && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
+        "cpd": "node_modules/jscpd/bin/jscpd src",
+        "vulnerabilities": "npm audit --only=prod"
+    },
+    "type": "module",
+    "files": [
+        "src/default.js",
+        "src/string-helper.js"
+    ],
+    "main": "src/default.js",
+    "devDependencies": {
+        "@babel/core": "^7.9.0",
+        "@babel/eslint-parser": "^7.14.7",
+        "@babel/plugin-transform-modules-commonjs": "^7.14.0",
+        "@babel/preset-env": "^7.9.5",
+        "@jest/globals": "^29.0.0",
+        "babel-jest": "^29.0.0",
+        "eslint": "^8.6.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-prettier": "^9.0.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-html": "^8.0.0",
+        "eslint-plugin-import": "^2.28.1",
+        "eslint-plugin-jsdoc": "^48.0.4",
+        "eslint-plugin-jsx-a11y": "^6.4.1",
+        "eslint-plugin-n": "^16.2.0",
+        "eslint-plugin-prettier": "^5.0.0",
+        "eslint-plugin-promise": "^6.1.1",
+        "eslint-plugin-sonarjs": "^0.24.0",
+        "jest": "^29.0.0",
+        "jscpd": "^3.2.1",
+        "prettier": "^3.0.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hckrnews/mutator"
+    },
+    "engines": {
+        "node": ">= 18"
+    },
+    "keywords": [
+        "object",
+        "mutate"
+    ]
+}

package/src/default.js

@@ -0,0 +1,45 @@
+import { capitalizeWords } from './string-helper.js'
+
+export default class DefaultMutator {
+  mapper ([key, value]) {
+    if (value === undefined || value === null || Number.isNaN(value)) {
+      return [key, undefined]
+    }
+
+    if (value.constructor === Object) {
+      const mappedResult = Object.entries(value).map(
+        ([subKey, subValue]) => {
+          const result = [`${key}_${subKey}`, subValue]
+          return [subKey, this.mapper(result)[1]]
+        }
+      )
+
+      const filteredResult = mappedResult.filter(Boolean)
+
+      return [key, Object.fromEntries(filteredResult)]
+    }
+
+    const fn = `set${capitalizeWords(key)}Attribute`
+    if (this?.[fn]?.constructor === Function) {
+      return [key, this[fn](value)]
+    }
+
+    return [key, value]
+  }
+
+  hydrate (data) {
+    const result = Object.entries(data).map(this.mapper.bind(this))
+    const filteredResult = result.filter(
+      ([key, value]) => key && value !== undefined
+    )
+
+    Object.assign(this, Object.fromEntries(filteredResult))
+  }
+
+  static create (data) {
+    const view = new this()
+    view.hydrate(data)
+
+    return view
+  }
+}

package/src/string-helper.js

@@ -0,0 +1,8 @@
+export const capitalizeFirstLetter = (string) =>
+  string.charAt(0).toUpperCase() + string.slice(1)
+
+export const capitalizeWords = (string) =>
+  string
+    .split(/_| /)
+    .map((word) => capitalizeFirstLetter(word))
+    .join('')