Merge branch 'release/v2.3.0'

chartshq · Dec 2, 2019 · 0b6712a · 0b6712a
2 parents 675d359 + 58ec694
commit 0b6712a
Show file tree

Hide file tree

Showing 47 changed files with 727 additions and 282 deletions.
diff --git a/checklist.txt b/checklist.txt
@@ -0,0 +1,19 @@
+Checklist to release a new build to NPM:
+  * Clone the repository if needed
+  * Checkout develop branch and make sure develop branch is up-to-date with remote
+  * If git flow is not initialized yet, Run: git flow init
+  * Create a new release branch, Run: git flow release start <new_version_with_v_character>
+  * Delete all existing npm dependencies, Run: rm -rf node_modules package-lock.json
+  * Install dependencies again, Run: npm install
+  * Update package version with new release version in package.json
+  * Update LICENSE file if needed
+  * Update README.md file if needed
+  * Now, create a release-ready build, Run: npm run build
+  * Test the dist/* files if needed
+  * Now commit all the changes with this message: "Make a build and bump version"
+  * Then finish the release, Run: git flow release finish [-s] <new_version_with_v_character> and enter release notes
+  * Push all changes and tags to remote, Run: git push origin master && git push origin develop && git push origin --tags
+  * Edit the title of the released tag in Github
+  * When everything is fine, it's ready to release
+  * Checkout master branch
+  * Now if everything is fine, release it to npm, Run: npm publish
diff --git a/dist/datamodel.js b/dist/datamodel.js
diff --git a/dist/datamodel.js.map b/dist/datamodel.js.map
diff --git a/example/index.html b/example/index.html
@@ -13,7 +13,7 @@
 
 <body>
   <!-- <script src="./samples/sample-with-split.js"></script> -->
-  <script src="./samples/example3.js"></script>
+  <script src="./samples/example2.js"></script>
 </body>
 
 </html>
diff --git a/example/samples/example2.js b/example/samples/example2.js
@@ -1,4 +1,59 @@
-const DataModel = window.DataModel.default;
+// const DataModel = window.DataModel.default;
+const columnMajor = (store) => {
+    let i = 0;
+    return (...fields) => {
+        fields.forEach((val, fieldIndex) => {
+            if (!(store[fieldIndex] instanceof Array)) {
+                store[fieldIndex] = Array.from({ length: i });
+            }
+            store[fieldIndex].push(val);
+        });
+        i++;
+    };
+};
+
+
+function FlatJSON222 (arr, schema) {
+    if (!Array.isArray(schema)) {
+        throw new Error('Schema missing or is in an unsupported format');
+    }
+
+    const header = {};
+    let i = 0;
+    let insertionIndex;
+    const columns = [];
+    const push = columnMajor(columns);
+    const schemaFieldsName = schema.map(unitSchema => unitSchema.name);
+
+    arr.forEach((item) => {
+        const fields = [];
+        schemaFieldsName.forEach((unitSchema) => {
+            if (unitSchema in header) {
+                insertionIndex = header[unitSchema];
+            } else {
+                header[unitSchema] = i++;
+                insertionIndex = i - 1;
+            }
+            fields[insertionIndex] = item[unitSchema];
+        });
+        push(...fields);
+    });
+
+    return [Object.keys(header), columns];
+}
+
+class JSONConverter2 extends DataModel.DataConverter{
+    constructor(){
+        super("json2")
+    }
+
+    convert(data , schema , options){
+        console.log("this is json2")
+        return FlatJSON222(data,schema,options);
+    }
+} 
+
+DataModel.Converters.register(new JSONConverter2());
 
 const schema = [
     {
@@ -50,13 +105,6 @@ const data = [
     }
 ];
 
-const dm = new DataModel(data, schema);
-const dataGenerated = dm.getData({
-    order: 'column',
-    formatter: {
-        birthday: val => new Date(val),
-        name: val => `Name: ${val}`
-    }
-});
+const dm = new DataModel(data, schema,{ dataFormat:"json2" });
 
-console.log(dataGenerated);
+console.log(dm.getData());
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "datamodel",
   "description": "Relational algebra compliant in-memory tabular data store",
   "homepage": "https://github.com/chartshq/datamodel",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "license": "MIT",
   "main": "dist/datamodel.js",
   "keywords": [

diff --git a/src/converter/dataConverterStore.js b/src/converter/dataConverterStore.js
@@ -0,0 +1,72 @@
+import DataConverter from './model/dataConverter';
+import { DSVStringConverter, DSVArrayConverter, JSONConverter, AutoDataConverter } from './defaultConverters';
+
+class DataConverterStore {
+    constructor() {
+        this.store = new Map();
+        this.converters(this._getDefaultConverters());
+    }
+
+    _getDefaultConverters() {
+        return [
+            new DSVStringConverter(),
+            new DSVArrayConverter(),
+            new JSONConverter(),
+            new AutoDataConverter()
+        ];
+    }
+
+    /**
+     * Sets the given converters in the store and returns the store
+     * @param  {Array<DataConverter>} converters : contains array of converter instance
+     * @return { Map<String,DataConverter> }
+     */
+    converters(converters = []) {
+        converters.forEach(converter => this.store.set(converter.type, converter));
+        return this.store;
+    }
+
+    /**
+     * Registers a Converter of type DataConverter
+     * @param {DataConverter} converter : converter Instance
+     * @returns self
+     */
+    register(converter) {
+        if (converter instanceof DataConverter) {
+            this.store.set(converter.type, converter);
+            return this;
+        }
+        return null;
+    }
+
+    /**
+     * Rempves a converter from store
+     * @param {DataConverter} converter : converter Instance
+     * @returns self
+     */
+
+    unregister(converter) {
+        this.store.delete(converter.type);
+        return this;
+    }
+
+    get(name) {
+        if (this.store.has(name)) {
+            return this.store.get(name);
+        }
+        return null;
+    }
+
+}
+
+const converterStore = (function () {
+    let store = null;
+
+    function getStore () {
+        store = new DataConverterStore();
+        return store;
+    }
+    return store || getStore();
+}());
+
+export default converterStore;
diff --git a/src/converter/dataConverterStore.spec.js b/src/converter/dataConverterStore.spec.js
@@ -0,0 +1,31 @@
+/* global describe, it */
+/* eslint-disable no-unused-expressions */
+
+import { expect } from 'chai';
+import converterStore from './dataConverterStore';
+import DataConverter from '../converter/model/dataConverter';
+
+describe('#DataConverterStore', () => {
+    it('should register and unregister converter', () => {
+        class JSONConverter2 extends DataConverter {
+            constructor() {
+                super('json2');
+            }
+
+            convert() {
+                return '';
+            }
+        }
+
+        const converter = new JSONConverter2();
+        converterStore.register(converter);
+        expect(converterStore.get('json2')).to.not.null;
+
+        converterStore.unregister(converter);
+        expect(converterStore.get('json2')).to.null;
+    });
+
+    it('should not register invalid Coverter', () => {
+        expect(converterStore.register(() => {})).to.null;
+    });
+});
diff --git a/src/converter/defaultConverters/autoConverter.js b/src/converter/defaultConverters/autoConverter.js
@@ -0,0 +1,13 @@
+import DataConverter from '../model/dataConverter';
+import AUTO from '../utils/auto-resolver';
+import DataFormat from '../../enums/data-format';
+
+export default class AutoDataConverter extends DataConverter {
+    constructor() {
+        super(DataFormat.AUTO);
+    }
+
+    convert(data, schema, options) {
+        return AUTO(data, schema, options);
+    }
+}
diff --git a/src/converter/defaultConverters/dsvArrayConverter.js b/src/converter/defaultConverters/dsvArrayConverter.js
@@ -0,0 +1,13 @@
+import DataConverter from '../model/dataConverter';
+import DSVArr from '../utils/dsv-arr';
+import DataFormat from '../../enums/data-format';
+
+export default class DSVArrayConverter extends DataConverter {
+    constructor() {
+        super(DataFormat.DSV_ARR);
+    }
+
+    convert(data, schema, options) {
+        return DSVArr(data, schema, options);
+    }
+}
diff --git a/src/converter/defaultConverters/dsvStringConverter.js b/src/converter/defaultConverters/dsvStringConverter.js
@@ -0,0 +1,13 @@
+import DataConverter from '../model/dataConverter';
+import DSVStr from '../utils/dsv-str';
+import DataFormat from '../../enums/data-format';
+
+export default class DSVStringConverter extends DataConverter {
+    constructor() {
+        super(DataFormat.DSV_STR);
+    }
+
+    convert(data, schema, options) {
+        return DSVStr(data, schema, options);
+    }
+}
diff --git a/src/converter/defaultConverters/index.js b/src/converter/defaultConverters/index.js
@@ -0,0 +1,4 @@
+export { default as DSVStringConverter } from './dsvStringConverter';
+export { default as JSONConverter } from './jsonConverter';
+export { default as DSVArrayConverter } from './dsvArrayConverter';
+export { default as AutoDataConverter } from './autoConverter';
diff --git a/src/converter/defaultConverters/jsonConverter.js b/src/converter/defaultConverters/jsonConverter.js
@@ -0,0 +1,13 @@
+import DataConverter from '../model/dataConverter';
+import FlatJSON from '../utils/flat-json';
+import DataFormat from '../../enums/data-format';
+
+export default class JSONConverter extends DataConverter {
+    constructor() {
+        super(DataFormat.FLAT_JSON);
+    }
+
+    convert(data, schema, options) {
+        return FlatJSON(data, schema, options);
+    }
+}
diff --git a/src/converter/defaultConverters/jsonConverter.spec.js b/src/converter/defaultConverters/jsonConverter.spec.js
@@ -0,0 +1,56 @@
+/* global describe, it ,beforeEach */
+/* eslint-disable no-unused-expressions */
+
+import { expect } from 'chai';
+import JSONConverter from './jsonConverter';
+
+describe('JSON Converter', () => {
+    let data;
+    let converter = new JSONConverter();
+    beforeEach(() => {
+        data = [
+            {
+                a: 1,
+                b: 2,
+                c: 3
+            },
+            {
+                a: 4,
+                b: 5,
+                c: 6
+            },
+            {
+                a: 7,
+                b: 8,
+                c: 9
+            }
+        ];
+    });
+
+    describe('#JSON', () => {
+        it('should convert to JSON data', () => {
+            const schema = [
+                {
+                    name: 'a',
+                    type: 'measure',
+                    subtype: 'continuous'
+                },
+                {
+                    name: 'b',
+                    type: 'measure',
+                    subtype: 'continuous'
+                },
+                {
+                    name: 'c',
+                    type: 'measure',
+                    subtype: 'continuous'
+                }
+            ];
+
+            const parsedData = converter.convert(data, schema);
+            const expected = [['a', 'b', 'c'], [[1, 4, 7], [2, 5, 8], [3, 6, 9]]];
+
+            expect(parsedData).to.deep.equal(expected);
+        });
+    });
+});
diff --git a/src/converter/index.js b/src/converter/index.js
@@ -1,4 +1,4 @@
-export { default as DSVArr } from './dsv-arr';
-export { default as DSVStr } from './dsv-str';
-export { default as FlatJSON } from './flat-json';
-export { default as Auto } from './auto-resolver';
+import converterStore from './dataConverterStore';
+import DataConverter from './model/dataConverter';
+
+export { DataConverter, converterStore };
diff --git a/src/converter/model/dataConverter.js b/src/converter/model/dataConverter.js
@@ -0,0 +1,17 @@
+/**
+ * Interface for all data converters
+ */
+export default class DataConverter {
+    constructor(type) {
+        this._type = type;
+    }
+
+    get type() {
+        return this._type;
+    }
+
+    convert() {
+        throw new Error('Convert method not implemented.');
+    }
+
+}
diff --git a/src/converter/model/dataConverter.spec.js b/src/converter/model/dataConverter.spec.js
@@ -0,0 +1,11 @@
+/* global describe, it */
+/* eslint-disable no-unused-expressions */
+
+import { expect } from 'chai';
+import DataConverter from './dataConverter';
+
+describe('#DataConverterModel', () => {
+    it('should throw error', () => {
+        expect(new DataConverter().convert).to.throw(Error, 'Convert method not implemented');
+    });
+});
diff --git a/src/converter/auto-resolver.js → src/converter/utils/auto-resolver.js b/src/converter/auto-resolver.js → src/converter/utils/auto-resolver.js
@@ -1,7 +1,7 @@
 import FlatJSON from './flat-json';
 import DSVArr from './dsv-arr';
 import DSVStr from './dsv-str';
-import { detectDataFormat } from '../utils';
+import { detectDataFormat } from '../../utils';
 
 /**
  * Parses the input data and detect the format automatically.

diff --git a/src/converter/auto-resolver.spec.js → src/converter/utils/auto-resolver.spec.js b/src/converter/auto-resolver.spec.js → src/converter/utils/auto-resolver.spec.js
diff --git a/src/converter/dsv-arr.js → src/converter/utils/dsv-arr.js b/src/converter/dsv-arr.js → src/converter/utils/dsv-arr.js
@@ -1,4 +1,4 @@
-import { columnMajor } from '../utils';
+import { columnMajor } from '../../utils';
 
 /**
  * Parses and converts data formatted in DSV array to a manageable internal format.

diff --git a/src/converter/dsv-arr.spec.js → src/converter/utils/dsv-arr.spec.js b/src/converter/dsv-arr.spec.js → src/converter/utils/dsv-arr.spec.js
diff --git a/src/converter/dsv-str.js → src/converter/utils/dsv-str.js b/src/converter/dsv-str.js → src/converter/utils/dsv-str.js
diff --git a/src/converter/dsv-str.spec.js → src/converter/utils/dsv-str.spec.js b/src/converter/dsv-str.spec.js → src/converter/utils/dsv-str.spec.js
diff --git a/src/converter/flat-json.js → src/converter/utils/flat-json.js b/src/converter/flat-json.js → src/converter/utils/flat-json.js
@@ -1,4 +1,4 @@
-import { columnMajor } from '../utils';
+import { columnMajor } from '../../utils';
 
 /**
  * Parses and converts data formatted in JSON to a manageable internal format.

diff --git a/src/converter/flat-json.spec.js → src/converter/utils/flat-json.spec.js b/src/converter/flat-json.spec.js → src/converter/utils/flat-json.spec.js