xlsx2json
Version:
Convert xlsx to JSON.
424 lines (391 loc) • 19.6 kB
JavaScript
/* global describe, it */
;
const assert = require('power-assert'),
xlsx2json = require('../lib/xlsx2json.js');
describe('xlsx2json(pathToXlsx, [options], [callback])', () => {
describe('Arguments', () => {
it('xlsx2json(pathToXlsx)', () => {
return xlsx2json('test/xlsx/data_only.xlsx').then(jsonValueArray => {
assert.deepEqual(
jsonValueArray,
[[
{A: 'value of A1', B: 'value of B1', C: 'value of C1'},
{A: 'value of A2', B: 'value of B2', C: 'value of C2'}
]]
);
});
});
it('xlsx2json(pathToXlsx, options)', () => {
return xlsx2json('test/xlsx/with_keys_row.xlsx', {keysRow: 1}).then(jsonValueArray => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value 1-A', 'column B': 'value 1-B', 'column-C': 'value 1-C'},
{'columnA': 'value 2-A', 'column B': 'value 2-B', 'column-C': 'value 2-C'}
]]
);
});
});
it('xlsx2json(pathToXlsx, callback)', done => {
xlsx2json('test/xlsx/data_only.xlsx', (error, jsonValueArray) => {
assert(jsonValueArray instanceof Array);
done();
});
});
it('xlsx2json(pathToXlsx, options, callback)', done => {
xlsx2json('test/xlsx/with_keys_row.xlsx', {keysRow: 1}, (error, jsonValueArray) => {
assert(jsonValueArray[0][1]['column-C'] === 'value 2-C');
done();
});
});
it('* Rejects and passes error, when invalid argument types are passed', () => {
return xlsx2json().catch(error => {
assert(error instanceof Error);
});
});
it('* Allows 4+ arguments (no particular meaning)', () => {
return xlsx2json('test/xlsx/data_only.xlsx', {}, () => {}, 'dummy argument')
.then(jsonValueArray => {
assert(jsonValueArray[0][0]['A'] === 'value of A1');
});
});
describe('pathToXlsx', () => {
it('指定されたパスに正常な.xlsxファイルが存在する場合は、該当ファイルの読み込み処理を開始する', () => {
return xlsx2json('test/xlsx/data_only.xlsx').then(jsonValueArray => {
assert(jsonValueArray instanceof Array);
});
});
describe('* if a file processing error occurred, callback function is called and promise is rejected', () => {
it('コールバック関数が呼び出される。その際、引数でErrorオブジェクトが渡される', done => {
xlsx2json('test/xlsx/__file_not_found__', error => {
assert(error instanceof Error);
done();
}).catch(error => void error);
});
it('関数実行時に返却されたPromiseがリジェクトされる。その際、引数でErrorオブジェクトが渡される', () => {
return xlsx2json('test/xlsx/__file_not_found__').catch(error => {
assert(error instanceof Error);
});
});
});
});
describe('options', () => {
describe('sheet:', () => {
const expectResult = [
[
{columnA: 'value Sheer1-1-A', 'column B': 'value Sheer1-1-B', 'column-C': 'value Sheer1-1-C'},
{columnA: 'value Sheer1-2-A', 'column B': 'value Sheer1-2-B', 'column-C': 'value Sheer1-2-C'}
],
[
{columnA: 'value Sheer2-1-A', 'column B': 'value Sheer2-1-B', 'column-C': 'value Sheer2-1-C'},
{columnA: 'value Sheer2-2-A', 'column B': 'value Sheer2-2-B', 'column-C': 'value Sheer2-2-C'}
],
[
{columnA: 'value Sheer3-1-A', 'column B': 'value Sheer3-1-B', 'column-C': 'value Sheer3-1-C'},
{columnA: 'value Sheer3-2-A', 'column B': 'value Sheer3-2-B', 'column-C': 'value Sheer3-2-C'}
]
];
describe('not set', () => {
it('Passes all sheets', () => {
return xlsx2json('test/xlsx/multiple_sheets.xlsx', {keysRow: 3, dataStartingRow: 4})
.then(jsonValueArray => {
assert.deepEqual(jsonValueArray, expectResult);
});
});
});
describe('{Number} (*zero-based sheet index)', () => {
it('Passes only selected sheet', () => {
return xlsx2json('test/xlsx/multiple_sheets.xlsx', {sheet: 1, keysRow: 3, dataStartingRow: 4})
.then(jsonValueArray => {
assert.deepEqual(jsonValueArray, expectResult[1]);
});
});
});
describe('{String}', () => {
it('Passes only selected sheet', () => {
return xlsx2json('test/xlsx/multiple_sheets.xlsx', {sheet: 'Sheet2', keysRow: 3, dataStartingRow: 4})
.then(jsonValueArray => {
assert.deepEqual(jsonValueArray, expectResult[1]);
});
});
});
describe('{Array}', () => {
it('Passes all matched sheets', () => {
return xlsx2json('test/xlsx/multiple_sheets.xlsx', {sheet: ['Sheet3', 0], keysRow: 3, dataStartingRow: 4})
.then(jsonValueArray => {
assert.deepEqual(jsonValueArray, [expectResult[2], expectResult[0]]);
});
});
});
describe('* not matched any sheets', () => {
it('Rejects and passes error', () => {
return xlsx2json('test/xlsx/multiple_sheets.xlsx', {sheet: 'NotMatch', keysRow: 3, dataStartingRow: 4})
.catch(error => {
assert(error instanceof Error);
});
});
});
});
describe('keysRow: {Number} (*one-based row position)', () => {
it('指定された行の各セルの値を、返却するオブジェクトの各key名にする', done => {
xlsx2json(
'test/xlsx/with_keys_row.xlsx',
{keysRow: 1},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value 1-A', 'column B': 'value 1-B', 'column-C': 'value 1-C'},
{'columnA': 'value 2-A', 'column B': 'value 2-B', 'column-C': 'value 2-C'}
]]
);
done();
}
);
});
it('指定された行に空のセルがある場合、該当するカラムの内容は、返却するオブジェクトに含めない', done => {
xlsx2json(
'test/xlsx/with_keys_row_include_empty_cell.xlsx',
{keysRow: 1},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value 1-A', 'column-C': 'value 1-C'},
{'columnA': 'value 2-A', 'column-C': 'value 2-C'}
]]
);
done();
}
);
});
it('指定された行は、返却される配列から除外される', done => {
xlsx2json(
'test/xlsx/with_keys_row.xlsx',
{keysRow: 1},
(error, jsonValueArray) => {
assert(jsonValueArray[0].length === 2);
done();
}
);
});
});
describe('mapping: {Object}', () => {
it('マッピングで示されたkeyに、該当するカラム位置の内容を格納する', done => {
xlsx2json(
'test/xlsx/data_only.xlsx',
{
mapping: {
columnA: 'A',
columnB: 2,
columnC: '3'
}
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value of A1', 'columnB': 'value of B1', 'columnC': 'value of C1'},
{'columnA': 'value of A2', 'columnB': 'value of B2', 'columnC': 'value of C2'}
]]
);
done();
}
);
});
it('マッピングで指定されないカラムは、返却するオブジェクトに含めない', done => {
xlsx2json(
'test/xlsx/data_only.xlsx',
{
mapping: {
columnA: 'A',
columnC: '3'
}
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value of A1', 'columnC': 'value of C1'},
{'columnA': 'value of A2', 'columnC': 'value of C2'}
]]
);
done();
}
);
});
describe('If both keysRow and mapping are specified', () => {
it('keysRowで指定された行の各セルの値に、mappingで指定されたkeyを加えたものを、返却するオブジェクトのkey名にする', done => {
xlsx2json(
'test/xlsx/with_keys_row.xlsx',
{
keysRow: 1,
mapping: {mappedA: 'A'}
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{
'mappedA': 'value 1-A',
'columnA': 'value 1-A',
'column B': 'value 1-B',
'column-C': 'value 1-C'
},
{
'mappedA': 'value 2-A',
'columnA': 'value 2-A',
'column B': 'value 2-B',
'column-C': 'value 2-C'
}
]]
);
done();
}
);
});
it('keysRowとmappingで、key名が重複する場合は、mappingによるカラム位置指定を優先する', done => {
xlsx2json(
'test/xlsx/with_keys_row.xlsx',
{
keysRow: 1,
mapping: {'column B': 'A'}
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'columnA': 'value 1-A', 'column B': 'value 1-A', 'column-C': 'value 1-C'},
{'columnA': 'value 2-A', 'column B': 'value 2-A', 'column-C': 'value 2-C'}
]]
);
done();
}
);
});
it('mappingでカラム位置に「0」を指定されたkeyがある場合、該当するカラム位置の内容は、返却するオブジェクトから除外する', done => {
xlsx2json(
'test/xlsx/with_keys_row.xlsx',
{
keysRow: 1,
mapping: {
'columnA': 0,
'column B': 0
}
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'column-C': 'value 1-C'},
{'column-C': 'value 2-C'}
]]
);
done();
}
);
});
});
});
describe('dataStartingRow: {Number} (*one-based row position)', () => {
it('指定された行を、内容を取得する最初の位置にする', done => {
xlsx2json(
'test/xlsx/with_header_information.xlsx',
{
dataStartingRow: 3
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'A': 'value 1-A', 'B': 'value 1-B', 'C': 'value 1-C'},
{'A': 'value 2-A', 'B': 'value 2-B', 'C': 'value 2-C'}
]]
);
done();
}
);
});
});
});
describe('callback', () => {
describe('function(error, jsonValueArray){ ... }', () => {
it('success', done => {
xlsx2json('test/xlsx/data_only.xlsx', (error, jsonValueArray) => {
assert(jsonValueArray instanceof Array);
done();
});
});
it('error', done => {
xlsx2json('test/xlsx/invalid_file_type.txt', function(error) {
assert(error instanceof Error);
done();
}).catch(error => void error);
});
});
});
});
describe('Returns', () => {
describe('Promise', () => {
it('.then(jsonValueArray => { ... })', () => {
return xlsx2json('test/xlsx/data_only.xlsx').then(jsonValueArray => {
assert(jsonValueArray instanceof Array);
});
});
it('.catch(error => { ... })', () => {
return xlsx2json('test/xlsx/invalid_file_type.txt').catch(function(error) {
assert(error instanceof Error);
});
});
});
});
describe('* extra', () => {
it('日本語文字が含まれるExcelデータも、問題なく処理する', done => {
xlsx2json(
'test/xlsx/japanese_characters.xlsx',
{
keysRow: 3,
dataStartingRow: 4
},
(error, jsonValueArray) => {
assert.deepEqual(
jsonValueArray,
[[
{'カラムA': '1-Aの値', 'カラム B': '1-Bの値', 'カラム-C': '1-Cの値'},
{'カラムA': '2-Aの値', 'カラム B': '2-Bの値', 'カラム-C': '2-Cの値'}
]]
);
done();
}
);
});
it('［テスト時の謎挙動］複数のシートが存在するファイルが対象で、結果をcallbackで受け取る場合に、power-assertへの値の取り回しに妙な挙動があったが、setTimeoutで回避できた', done => {
xlsx2json(
'test/xlsx/multiple_sheets.xlsx',
{keysRow: 3, dataStartingRow: 4},
(error, jsonValueArray) => {
setTimeout(() => {
assert.deepEqual(
jsonValueArray,
[
[
{columnA: 'value Sheer1-1-A', 'column B': 'value Sheer1-1-B', 'column-C': 'value Sheer1-1-C'},
{columnA: 'value Sheer1-2-A', 'column B': 'value Sheer1-2-B', 'column-C': 'value Sheer1-2-C'}
],
[
{columnA: 'value Sheer2-1-A', 'column B': 'value Sheer2-1-B', 'column-C': 'value Sheer2-1-C'},
{columnA: 'value Sheer2-2-A', 'column B': 'value Sheer2-2-B', 'column-C': 'value Sheer2-2-C'}
],
[
{columnA: 'value Sheer3-1-A', 'column B': 'value Sheer3-1-B', 'column-C': 'value Sheer3-1-C'},
{columnA: 'value Sheer3-2-A', 'column B': 'value Sheer3-2-B', 'column-C': 'value Sheer3-2-C'}
]
]
);
done();
}, 0);
}
);
});
});
});