mirror of
https://github.com/bringout/oca-ocb-technical.git
synced 2026-04-21 09:12:05 +02:00
Initial commit: Technical packages
This commit is contained in:
Ernad Husremovic
commit
3473fa71a0
873 changed files with 297766 additions and 0 deletions
|
|
@ -0,0 +1,195 @@
|
|||
odoo.define('barcodes_gs1_nomenclature/static/src/js/barcode_parser.js', function (require) {
|
||||
"use strict";
|
||||
|
||||
const BarcodeParser = require('barcodes.BarcodeParser');
|
||||
const FNC1_CHAR = String.fromCharCode(29);
|
||||
const {_lt} = require('web.core');
|
||||
class GS1BarcodeError extends Error {};
|
||||
|
||||
BarcodeParser.include({
|
||||
init: function(attributes) {
|
||||
this._super(...arguments);
|
||||
// Use the nomenclature's separaor regex, else use an impossible one.
|
||||
const nomenclatureSeparator = this.nomenclature && this.nomenclature.gs1_separator_fnc1;
|
||||
this.gs1SeparatorRegex = new RegExp(nomenclatureSeparator || '.^', 'g');
|
||||
},
|
||||
|
||||
/**
|
||||
* Convert YYMMDD GS1 date into a Date object
|
||||
*
|
||||
* @param {string} gs1Date YYMMDD string date, length must be 6
|
||||
* @returns {Date}
|
||||
*/
|
||||
gs1_date_to_date: function(gs1Date) {
|
||||
// See 7.12 Determination of century in dates:
|
||||
// https://www.gs1.org/sites/default/files/docs/barcodes/GS1_General_Specifications.pdfDetermination of century
|
||||
const now = new Date();
|
||||
const substractYear = parseInt(gs1Date.slice(0, 2)) - (now.getFullYear() % 100);
|
||||
let century = Math.floor(now.getFullYear() / 100);
|
||||
if (51 <= substractYear && substractYear <= 99) {
|
||||
century--;
|
||||
} else if (-99 <= substractYear && substractYear <= -50) {
|
||||
century++;
|
||||
}
|
||||
const year = century * 100 + parseInt(gs1Date.slice(0, 2));
|
||||
const date = new Date(year, parseInt(gs1Date.slice(2, 4) - 1));
|
||||
|
||||
if (gs1Date.slice(-2) === '00'){
|
||||
// Day is not mandatory, when not set -> last day of the month
|
||||
date.setDate(new Date(year, parseInt(gs1Date.slice(2, 4)), 0).getDate());
|
||||
} else {
|
||||
date.setDate(parseInt(gs1Date.slice(-2)));
|
||||
}
|
||||
return date;
|
||||
},
|
||||
|
||||
/**
|
||||
* Perform interpretation of the barcode value depending ot the rule.gs1_content_type
|
||||
*
|
||||
* @param {Array} match Result of a regex match with atmost 2 groups (ia and value)
|
||||
* @param {Object} rule Matched Barcode Rule
|
||||
* @returns {Object|null}
|
||||
*/
|
||||
parse_gs1_rule_pattern: function(match, rule) {
|
||||
const result = {
|
||||
rule: Object.assign({}, rule),
|
||||
ai: match[1],
|
||||
string_value: match[2],
|
||||
code: match[2],
|
||||
base_code: match[2],
|
||||
type: rule.type
|
||||
};
|
||||
if (rule.gs1_content_type === 'measure'){
|
||||
let decimalPosition = 0; // Decimal position begin at the end, 0 means no decimal
|
||||
if (rule.gs1_decimal_usage){
|
||||
decimalPosition = parseInt(match[1][match[1].length - 1]);
|
||||
}
|
||||
if (decimalPosition > 0) {
|
||||
const integral = match[2].slice(0, match[2].length - decimalPosition);
|
||||
const decimal = match[2].slice(match[2].length - decimalPosition);
|
||||
result.value = parseFloat( integral + "." + decimal);
|
||||
} else {
|
||||
result.value = parseInt(match[2]);
|
||||
}
|
||||
} else if (rule.gs1_content_type === 'identifier'){
|
||||
if (parseInt(match[2][match[2].length - 1]) !== this.get_barcode_check_digit("0".repeat(18 - match[2].length) + match[2])){
|
||||
throw new Error(_lt("Invalid barcode: the check digit is incorrect"));
|
||||
// return {error: _lt("Invalid barcode: the check digit is incorrect")};
|
||||
}
|
||||
result.value = match[2];
|
||||
} else if (rule.gs1_content_type === 'date'){
|
||||
if (match[2].length !== 6){
|
||||
throw new Error(_lt("Invalid barcode: can't be formated as date"));
|
||||
// return {error: _lt("Invalid barcode: can't be formated as date")};
|
||||
}
|
||||
result.value = this.gs1_date_to_date(match[2]);
|
||||
} else {
|
||||
result.value = match[2];
|
||||
}
|
||||
return result;
|
||||
},
|
||||
|
||||
/**
|
||||
* Try to decompose the gs1 extanded barcode into several unit of information using gs1 rules.
|
||||
*
|
||||
* @param {string} barcode
|
||||
* @returns {Array} Array of object
|
||||
*/
|
||||
gs1_decompose_extanded: function(barcode) {
|
||||
const results = [];
|
||||
const rules = this.nomenclature.rules.filter(rule => rule.encoding === 'gs1-128');
|
||||
const separatorReg = FNC1_CHAR + "?";
|
||||
barcode = this._convertGS1Separators(barcode);
|
||||
barcode = this.cleanBarcode(barcode);
|
||||
|
||||
while (barcode.length > 0) {
|
||||
const barcodeLength = barcode.length;
|
||||
for (const rule of rules) {
|
||||
const match = barcode.match("^" + rule.pattern + separatorReg);
|
||||
if (match && match.length >= 3) {
|
||||
const res = this.parse_gs1_rule_pattern(match, rule);
|
||||
if (res) {
|
||||
barcode = barcode.slice(match.index + match[0].length);
|
||||
results.push(res);
|
||||
if (barcode.length === 0) {
|
||||
return results; // Barcode completly parsed, no need to keep looping.
|
||||
}
|
||||
} else {
|
||||
throw new GS1BarcodeError(_lt("This barcode can't be parsed by any barcode rules."));
|
||||
}
|
||||
}
|
||||
}
|
||||
if (barcodeLength === barcode.length) {
|
||||
throw new GS1BarcodeError(_lt("This barcode can't be partially or fully parsed."));
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* @override
|
||||
* @returns {Object|Array|null} If nomenclature is GS1, returns an array or null
|
||||
*/
|
||||
parse_barcode: function(barcode){
|
||||
if (this.nomenclature && this.nomenclature.is_gs1_nomenclature) {
|
||||
return this.gs1_decompose_extanded(barcode);
|
||||
}
|
||||
return this._super(...arguments);
|
||||
},
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Private
|
||||
//--------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* @override
|
||||
*/
|
||||
_barcodeNomenclatureFields: function () {
|
||||
const fieldNames = this._super(...arguments);
|
||||
fieldNames.push('is_gs1_nomenclature', 'gs1_separator_fnc1');
|
||||
return fieldNames;
|
||||
},
|
||||
|
||||
/**
|
||||
* @override
|
||||
*/
|
||||
_barcodeRuleFields: function () {
|
||||
const fieldNames = this._super(...arguments);
|
||||
fieldNames.push('gs1_content_type', 'gs1_decimal_usage', 'associated_uom_id');
|
||||
return fieldNames;
|
||||
},
|
||||
|
||||
/**
|
||||
* Makes all needed operations to clean and prepare the barcode.
|
||||
* @param {string} barcode
|
||||
* @returns {string}
|
||||
*/
|
||||
cleanBarcode(barcode) {
|
||||
if (barcode[0] === FNC1_CHAR) {
|
||||
// If first character is the separator, remove it to be able to parse the barcode.
|
||||
barcode = barcode.slice(1);
|
||||
}
|
||||
return barcode;
|
||||
},
|
||||
|
||||
/**
|
||||
* The FNC1 is the default GS1 separator character, but through the field `gs1_separator_fnc1`,
|
||||
* the user has the possibility to define one or multiple characters to use as separator as
|
||||
* a regex. This method replaces all of the matches in the given barcode by the FNC1.
|
||||
*
|
||||
* @param {string} barcode
|
||||
* @returns {string}
|
||||
*/
|
||||
_convertGS1Separators: function (barcode) {
|
||||
barcode = barcode.replace(this.gs1SeparatorRegex, FNC1_CHAR);
|
||||
return barcode;
|
||||
},
|
||||
});
|
||||
|
||||
return {
|
||||
BarcodeParser,
|
||||
FNC1_CHAR,
|
||||
GS1BarcodeError
|
||||
};
|
||||
});
|
||||
|
|
@ -0,0 +1,290 @@
|
|||
odoo.define('barcodes_gs1_nomenclature/static/src/js/tests/barcode_parser_tests.js', function (require) {
|
||||
"use strict";
|
||||
|
||||
const BarcodeParser = require('barcodes.BarcodeParser');
|
||||
const { barcodeService } = require('@barcodes/barcode_service');
|
||||
|
||||
|
||||
QUnit.module('Barcodes', {}, function () {
|
||||
QUnit.module('Barcode GS1 Parser', {
|
||||
beforeEach: function () {
|
||||
this.data = {
|
||||
'barcode.nomenclature': {
|
||||
fields: {
|
||||
name: {type: 'char', string: 'Barcode Nomenclature'},
|
||||
rule_ids: {type: 'one2many', relation: 'barcode.rule'},
|
||||
upc_ean_conv: {type: 'selection', string: 'UPC/EAN Conversion'},
|
||||
is_gs1_nomenclature: {type: 'boolean', string: 'Is GS1 Nomenclature'},
|
||||
gs1_separator_fnc1: {type: 'char', string: 'FNC1 Seperator Alternative'}
|
||||
},
|
||||
records: [
|
||||
{id: 1, name: "normal", upc_ean_conv: "always", is_gs1_nomenclature: false, gs1_separator_fnc1: ''},
|
||||
{id: 2, name: "GS1", upc_ean_conv: "always", is_gs1_nomenclature: true, gs1_separator_fnc1: ''},
|
||||
],
|
||||
},
|
||||
'barcode.rule': {
|
||||
fields: {
|
||||
name: {type: 'char', string: 'Barcode Nomenclature'},
|
||||
barcode_nomenclature_id: {type: 'many2one', relation: 'barcode.nomenclature'},
|
||||
sequence: {type: 'integer', string: 'Sequence'},
|
||||
encoding: {type: 'selection', string: 'Encoding'},
|
||||
type: {type: 'selection', string: 'Type'},
|
||||
pattern: {type: 'Char', string: 'Pattern'},
|
||||
alias: {type: 'Char', string: 'Alias'},
|
||||
},
|
||||
records: [
|
||||
{id: 1, name: "Product Barcodes", barcode_nomenclature_id: 1, sequence: 90, type: 'product', encoding: 'any', pattern: ".*"},
|
||||
{
|
||||
id: 2,
|
||||
name: "Global Trade Item Number (GTIN)",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 100,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(01)(\\d{14})",
|
||||
type: "product",
|
||||
gs1_content_type: "identifier",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 3,
|
||||
name: "GTIN of contained trade items",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 101,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(02)(\\d{14})",
|
||||
type: "product",
|
||||
gs1_content_type: "identifier",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 4,
|
||||
name: "Batch or lot number",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 102,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(10)([!\"%/0-9:?A-Za-z]{0,20})",
|
||||
type: "product",
|
||||
gs1_content_type: "alpha",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 5,
|
||||
name: "Serial number",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(21)([!\"%/0-9:?A-Za-z]{0,20})",
|
||||
type: "product",
|
||||
gs1_content_type: "alpha",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 6,
|
||||
name: "Pack date (YYMMDD)",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 103,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(13)(\\d{6})",
|
||||
type: "pack_date",
|
||||
gs1_content_type: "date",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 7,
|
||||
name: "Best before date (YYMMDD)",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 104,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(15)(\\d{6})",
|
||||
type: "use_date",
|
||||
gs1_content_type: "date",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 8,
|
||||
name: "Expiration date (YYMMDD)",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(16)(\\d{6})",
|
||||
type: "expiration_date",
|
||||
gs1_content_type: "date",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 9,
|
||||
name: "Variable count of items (variabl",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(30)(\\d{0,8})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 10,
|
||||
name: "Count of trade items or trade it",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(37)(\\d{0,8})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: false
|
||||
}, {
|
||||
id: 11,
|
||||
name: "Net weight, kilograms (variable",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(310[0-5])(\\d{6})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: true
|
||||
}, {
|
||||
id: 12,
|
||||
name: "Length or first dimension, metre",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(311[0-5])(\\d{6})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: true
|
||||
}, {
|
||||
id: 13,
|
||||
name: "Net volume, litres (variable mea",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(315[0-5])(\\d{6})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: true
|
||||
}, {
|
||||
id: 14,
|
||||
name: "Length or first dimension, inche",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(321[0-5])(\\d{6})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: true
|
||||
}, {
|
||||
id: 15,
|
||||
name: "Net weight (or volume), ounces (",
|
||||
barcode_nomenclature_id: 2,
|
||||
sequence: 105,
|
||||
encoding: "gs1-128",
|
||||
pattern: "(357[0-5])(\\d{6})",
|
||||
type: "product",
|
||||
gs1_content_type: "measure",
|
||||
gs1_decimal_usage: true
|
||||
}
|
||||
],
|
||||
}
|
||||
};
|
||||
}
|
||||
}, function () {
|
||||
QUnit.test('Test gs1 date barcode', async function (assert) {
|
||||
assert.expect(9);
|
||||
const barcodeNomenclature = new BarcodeParser({'nomenclature_id': 2});
|
||||
await barcodeNomenclature.loaded;
|
||||
|
||||
// 20/10/2015 -> 151020
|
||||
let dateGS1 = "151020";
|
||||
let date = barcodeNomenclature.gs1_date_to_date(dateGS1);
|
||||
assert.equal(date.getDate(), 20);
|
||||
assert.equal(date.getMonth() + 1, 10);
|
||||
assert.equal(date.getFullYear(), 2015);
|
||||
|
||||
// XX/03/2052 -> 520300 -> (if day no set take last day of the month -> 31)
|
||||
dateGS1 = "520300";
|
||||
date = barcodeNomenclature.gs1_date_to_date(dateGS1);
|
||||
assert.equal(date.getDate(), 31);
|
||||
assert.equal(date.getMonth() + 1, 3);
|
||||
assert.equal(date.getFullYear(), 2052);
|
||||
|
||||
// XX/02/2020 -> 520200 -> (if day no set take last day of the month -> 29)
|
||||
dateGS1 = "200200";
|
||||
date = barcodeNomenclature.gs1_date_to_date(dateGS1);
|
||||
assert.equal(date.getDate(), 29);
|
||||
assert.equal(date.getMonth() + 1, 2);
|
||||
assert.equal(date.getFullYear(), 2020);
|
||||
});
|
||||
|
||||
QUnit.test('Test gs1 decompose extanded', async function (assert) {
|
||||
assert.expect(37);
|
||||
const barcodeNomenclature = new BarcodeParser({'nomenclature_id': 2});
|
||||
await barcodeNomenclature.loaded;
|
||||
|
||||
barcodeNomenclature.nomenclature = this.data['barcode.nomenclature'].records[0];
|
||||
barcodeNomenclature.nomenclature.rules = this.data['barcode.rule'].records;
|
||||
|
||||
// (01)94019097685457(10)33650100138(3102)002004(15)131018
|
||||
let code128 = "01940190976854571033650100138\x1D310200200415131018";
|
||||
let res = barcodeNomenclature.gs1_decompose_extanded(code128);
|
||||
assert.equal(res.length, 4);
|
||||
assert.equal(res[0].ai, "01");
|
||||
|
||||
assert.equal(res[1].ai, "10");
|
||||
|
||||
assert.equal(res[2].ai, "3102");
|
||||
assert.equal(res[2].value, 20.04);
|
||||
|
||||
assert.equal(res[3].ai, "15");
|
||||
assert.equal(typeof res[3].value.getFullYear, 'function');
|
||||
assert.equal(res[3].value.getFullYear(), 2013);
|
||||
assert.equal(res[3].value.getDate(), 18);
|
||||
assert.equal(res[3].value.getMonth() + 1, 10);
|
||||
|
||||
// Check multiple variants of the same GS1, the result should be always the same.
|
||||
// (01)94019097685457(30)17(13)170119
|
||||
const gs1Barcodes = [
|
||||
"0194019097685457300000001713170119",
|
||||
"\x1D0194019097685457300000001713170119",
|
||||
"01940190976854573017\x1D13170119",
|
||||
];
|
||||
for (const gs1Barcode of gs1Barcodes) {
|
||||
res = barcodeNomenclature.gs1_decompose_extanded(gs1Barcode);
|
||||
assert.equal(res.length, 3);
|
||||
assert.equal(res[0].ai, "01");
|
||||
|
||||
assert.equal(res[1].ai, "30");
|
||||
assert.equal(res[1].value, 17);
|
||||
|
||||
assert.equal(res[2].ai, "13");
|
||||
assert.equal(typeof res[2].value.getFullYear, "function");
|
||||
assert.equal(res[2].value.getFullYear(), 2017);
|
||||
assert.equal(res[2].value.getDate(), 19);
|
||||
assert.equal(res[2].value.getMonth() + 1, 1);
|
||||
}
|
||||
});
|
||||
|
||||
QUnit.test('Test Alternative GS1 Separator (fnc1)', async function (assert) {
|
||||
assert.expect(6);
|
||||
const nomenclature = this.data['barcode.nomenclature'].records[1];
|
||||
nomenclature.rules = this.data['barcode.rule'].records;
|
||||
let barcodeNomenclature = new BarcodeParser({ nomenclature });
|
||||
await barcodeNomenclature.loaded;
|
||||
|
||||
// (21)12345(15)090101(16)100101
|
||||
const code128 = "2112345#1509010116100101";
|
||||
let res;
|
||||
try {
|
||||
res = barcodeNomenclature.gs1_decompose_extanded(barcodeService.cleanBarcode(code128));
|
||||
} catch (error) {
|
||||
assert.ok(
|
||||
error instanceof Error,
|
||||
"Still using the default separator, so using a custom separator shouldn't work"
|
||||
);
|
||||
}
|
||||
|
||||
// Reload the nomenclature but this time using '#' as separator.
|
||||
nomenclature.gs1_separator_fnc1 = '#';
|
||||
barcodeNomenclature = new BarcodeParser({ nomenclature });
|
||||
res = barcodeNomenclature.gs1_decompose_extanded(barcodeService.cleanBarcode(code128));
|
||||
await barcodeNomenclature.loaded;
|
||||
assert.equal(res.length, 3);
|
||||
assert.equal(res[0].ai, "21");
|
||||
assert.equal(res[0].value, "12345");
|
||||
assert.equal(res[1].ai, "15");
|
||||
assert.equal(res[2].ai, "16");
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue