Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Imitate BEMHTML export behaviour #28

Merged
merged 1 commit into from
May 8, 2015
Merged

Imitate BEMHTML export behaviour #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ $ npm install --save-dev enb-bh
* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`.
* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`.
* *Boolean* **sourcemap** — строить карты кода.
* *String* **mimic** — имя переменной для экспорта.
* *String|Array* **mimic** — имена переменных для экспорта.
* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `js`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`.

Expand All @@ -54,7 +54,7 @@ nodeConfig.addTech(require('enb-bh/techs/bh-client'));
* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`.
* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`.
* *Boolean* **sourcemap** — строить карты кода.
* *String* **mimic** — имя модуля для экспорта.
* *String|Array* **mimic** — имена модулей для экспорта.
* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `js`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`.

Expand All @@ -73,6 +73,7 @@ nodeConfig.addTech(require('enb-bh/techs/bh-client-module'));
* *String* **target** — Результирующий таргет. По умолчанию — `?.bh.js`.
* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`.
* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`.
* *String|Array* **mimic** — имена переменных для экспорта.
* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `js`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`.

Expand All @@ -92,6 +93,7 @@ nodeConfig.addTech(require('enb-bh/techs/bh-server'));
* *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов (его предоставляет технология `files`). По умолчанию — `?.files`.
* *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — `['bh.js']`.
* *Boolean* **sourcemap** — строить карты кода.
* *String|Array* **mimic** — имена переменных для экспорта.
* *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* *String* **jsAttrScheme** — Схема данных для параметров инициализации. По умолчанию — `js`. Форматы: `js` — Получаем `return { ... }`. `json` — JSON-формат. Получаем `{ ... }`.

Expand Down
18 changes: 11 additions & 7 deletions lib/bh-client-processor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module.exports = {
* @param {Object} dependencies example: {libName: "dependencyName"}
* @param {String} jsAttrName
* @param {String} jsAttrScheme
* @param {String} mimic
* @param {String|Array} mimic
* @returns {string}
*/
buildModule: function (targetPath, bhEngine, inputSources, dependencies, jsAttrName, jsAttrScheme,
Expand All @@ -29,7 +29,9 @@ module.exports = {
this._defineModule('bh', file, dependencies, bhEngine, inputSources, jsAttrName, jsAttrScheme, true);

if (mimic) {
this._defineModule(mimic, file, { bh: 'bh' });
[].concat(mimic).forEach(function (name) {
this._defineModule(name, file, { bh: 'bh' });
}, this);
}

return file;
Expand All @@ -43,7 +45,7 @@ module.exports = {
* @param {String} jsAttrName
* @param {String} jsAttrScheme
* @param {Boolean} useSourceMap
* @param {String} mimic
* @param {String|Array} mimic
* @returns {string}
*/
build: function (targetPath, bhEngine, inputSources, dependencies, jsAttrName, jsAttrScheme, useSourceMap, mimic) {
Expand All @@ -67,7 +69,7 @@ module.exports = {
* @param {Object} dependencies example: {libName: "dependencyName"}
* @param {String} jsAttrName
* @param {String} jsAttrScheme
* @param {String} [mimic]
* @param {String|Array} [mimic]
* @returns {Object} enb-source-map/lib/file instance
*/
_concatFile: function (file, bhEngine, inputSources, dependencies, jsAttrName, jsAttrScheme, mimic) {
Expand All @@ -81,9 +83,11 @@ module.exports = {
file.writeLine('});');

if (mimic) {
file.writeLine('if (typeof ' + mimic + ' === \'undefined\') {');
file.writeLine('var ' + mimic + ' = bh;');
file.writeLine('}');
[].concat(mimic).forEach(function (name) {
file.writeLine('if (typeof ' + name + ' === \'undefined\') {');
file.writeLine('var ' + name + ' = bh;');
file.writeLine('}');
});
}

libPrepares.forEach(function (libPrepare) {
Expand Down
4 changes: 2 additions & 2 deletions techs/bh-client-module.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* (его предоставляет технология `files`). По умолчанию — `?.files`.
* * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — ['bh'].
* * *Boolean* **sourcemap** — строить карты кода.
* * *String* **mimic** — имя модуля для экспорта.
* * *String|Array* **mimic** — имена модулей для экспорта.
* * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* * *String* **jsAttrScheme** — Cхема данных для параметров инициализации. По умолчанию — `js`.
* * Форматы:
Expand All @@ -35,7 +35,7 @@ module.exports = require('enb/lib/build-flow').create()
.target('target', '?.bh.client.js')
.defineOption('bhFile', '')
.defineOption('dependencies', {})
.defineOption('mimic')
.defineOption('mimic', [])
.defineOption('jsAttrName', 'onclick')
.defineOption('jsAttrScheme', 'js')
.defineOption('sourcemap', false)
Expand Down
4 changes: 2 additions & 2 deletions techs/bh-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* (его предоставляет технология `files`). По умолчанию — `?.files`.
* * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — ['bh'].
* * *Boolean* **sourcemap** — строить карты кода.
* * *String* **mimic** — имя переменной для экспорта.
* * *String|Array* **mimic** — имена переменных для экспорта.
* * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* * *String* **jsAttrScheme** — Cхема данных для параметров инициализации. По умолчанию — `js`.
* * Форматы:
Expand All @@ -35,7 +35,7 @@ module.exports = require('enb/lib/build-flow').create()
.target('target', '?.bh.client.js')
.defineOption('bhFile', '')
.defineOption('dependencies', {})
.defineOption('mimic')
.defineOption('mimic', [])
.defineOption('jsAttrName', 'onclick')
.defineOption('jsAttrScheme', 'js')
.defineOption('sourcemap', false)
Expand Down
9 changes: 9 additions & 0 deletions techs/bh-server-include.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* (его предоставляет технология `files`). По умолчанию — `?.files`.
* * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — ['bh'].
* * *Boolean* **sourcemap** — строить карты кода.
* * *String|Array* **mimic** — имена модулей для экспорта.
* * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* * *String* **jsAttrScheme** — Cхема данных для параметров инициализации. По умолчанию — `js`.
* * Форматы:
Expand All @@ -34,6 +35,7 @@ module.exports = require('enb/lib/build-flow').create()
.name('bh-server-include')
.target('target', '?.bh.js')
.defineOption('bhFile', '')
.defineOption('mimic', [])
.defineOption('jsAttrName', 'onclick')
.defineOption('jsAttrScheme', 'js')
.defineOption('sourcemap', false)
Expand All @@ -49,6 +51,7 @@ module.exports = require('enb/lib/build-flow').create()
.builder(function (bhFiles) {
var node = this.node,
dependencies = {},
mimic = this._mimic,
jsAttrName = this._jsAttrName,
jsAttrScheme = this._jsAttrScheme,
sourcemap = this._sourcemap,
Expand All @@ -75,6 +78,12 @@ module.exports = require('enb/lib/build-flow').create()

file.writeLine('module.exports = bh;');

if (mimic) {
[].concat(mimic).forEach(function (name) {
file.writeLine('bh[\'' + name + '\'] = bh;');
});
}

return file.render();
});
})
Expand Down
7 changes: 6 additions & 1 deletion techs/bh-server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* * *String* **filesTarget** — files-таргет, на основе которого получается список исходных файлов
* (его предоставляет технология `files`). По умолчанию — `?.files`.
* * *String* **sourceSuffixes** — суффиксы файлов, по которым строится `files`-таргет. По умолчанию — ['bh.js'].
* * *String|Array* **mimic** — имена модулей для экспорта.
* * *String* **jsAttrName** — атрибут блока с параметрами инициализации. По умолчанию — `onclick`.
* * *String* **jsAttrScheme** — Cхема данных для параметров инициализации. По умолчанию — `js`.
* * Форматы:
Expand All @@ -31,6 +32,7 @@ module.exports = require('enb/lib/build-flow').create()
.name('bh-server')
.target('target', '?.bh.js')
.defineOption('bhFile', '')
.defineOption('mimic', [])
.defineOption('jsAttrName', 'onclick')
.defineOption('jsAttrScheme', 'js')
.useFileList(['bh.js'])
Expand Down Expand Up @@ -97,7 +99,10 @@ module.exports = require('enb/lib/build-flow').create()
return buildRequire(file.fullname, '', '(bh)');
}).join('\n'),
'',
'module.exports = bh;'
'module.exports = bh;',
this._mimic ? [].concat(this._mimic).map(function (name) {
return 'bh[\'' + name + '\'] = bh;';
}).join('\n') : ''
].join('\n');
})
.createTech();
52 changes: 37 additions & 15 deletions test/techs/bh-client-module.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,45 @@ describe('bh-client-module', function () {
return runTest(test, options);
});

it('mimic', function () {
var test = [
'chai.should();',
'describe("bh-client-module", function () {',
'it("autogenerated test", function (done) {',
'modules.require("BEMHTML", function (BEMHTML) {',
'BEMHTML.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'done();',
describe('mimic', function () {
it('mimic as a string', function () {
var test = [
'chai.should();',
'describe("bh-client-module", function () {',
'it("autogenerated test", function (done) {',
'modules.require("BEMHTML", function (BEMHTML) {',
'BEMHTML.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'done();',
'});',
'});',
'});',
'});'
].join('\n'),
options = {
mimic: 'BEMHTML'
};
'});'
].join('\n'),
options = {
mimic: 'BEMHTML'
};

return runTest(test, options);
});

return runTest(test, options);
it('mimic to different template engines', function () {
var test = [
'chai.should();',
'describe("bh-client-module", function () {',
'it("autogenerated test", function (done) {',
'modules.require(["BEMHTML", "render"], function (BEMHTML, render) {',
'BEMHTML.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'render.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'done();',
'});',
'});',
'});'
].join('\n'),
options = {
mimic: ['BEMHTML', 'render']
};

return runTest(test, options);
});
});

describe('jsAttr', function () {
Expand Down
35 changes: 35 additions & 0 deletions test/techs/bh-client.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,41 @@ describe('bh-client', function () {
return runTest(test, options);
});

describe('mimic', function () {
it('mimic as a string', function () {
var test = [
'chai.should();',
'describe("bh-client", function () {',
'it("autogenerated test", function () {',
'BEMHTML.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'})',
'})'
].join('\n'),
options = {
mimic: 'BEMHTML'
};

return runTest(test, options);
});

it('mimic to different template engines', function () {
var test = [
'chai.should();',
'describe("bh-client", function () {',
'it("autogenerated test", function () {',
'BEMHTML.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'render.apply({ block: "block" }).should.equal(\'<a class="block"></a>\');',
'})',
'})'
].join('\n'),
options = {
mimic: ['BEMHTML', 'render']
};

return runTest(test, options);
});
});

describe('jsAttr', function () {
it('should use dafault jsAttrName and jsAttrScheme params', function () {
var test = generateTest(
Expand Down
28 changes: 28 additions & 0 deletions test/techs/bh-server-include.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,30 @@ describe('bh-server-include', function () {
return assert(bemjson, html, templates);
});

describe('mimic', function () {
it('mimic to BEMHTML', function () {
var templates = [
'bh.match("block", function(ctx) {ctx.tag("a");});'
],
bemjson = { block: 'block' },
html = '<a class="block"></a>',
options = { mimic: 'BEMHTML' };

return assert(bemjson, html, templates, options);
});

it('mimic as an array', function () {
var templates = [
'bh.match("block", function(ctx) {ctx.tag("a");});'
],
bemjson = { block: 'block' },
html = '<a class="block"></a>',
options = { mimic: ['BH', 'BEMHTML'] };

return assert(bemjson, html, templates, options);
});
});

describe('caches', function () {
it('must use cached bhFile', function () {
var scheme = {
Expand Down Expand Up @@ -254,5 +278,9 @@ function assert(bemjson, html, templates, options) {
return bundle.runTechAndRequire(bhServerInclude, options)
.spread(function (bh) {
bh.apply(bemjson).must.be(html);

options && options.mimic && [].concat(options.mimic).forEach(function (name) {
bh[name].apply(bemjson).must.be(html);
});
});
}
28 changes: 28 additions & 0 deletions test/techs/bh-server.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,30 @@ describe('bh-server', function () {
});
});

describe('mimic', function () {
it('mimic to BEMHTML', function () {
var templates = [
'bh.match("block", function(ctx) {ctx.tag("a");});'
],
bemjson = { block: 'block' },
html = '<a class="block"></a>',
options = { mimic: 'BEMHTML' };

return assert(bemjson, html, templates, options);
});

it('mimic as an array', function () {
var templates = [
'bh.match("block", function(ctx) {ctx.tag("a");});'
],
bemjson = { block: 'block' },
html = '<a class="block"></a>',
options = { mimic: ['BH', 'BEMHTML'] };

return assert(bemjson, html, templates, options);
});
});

describe('caches', function () {
it('must use cached bhFile', function () {
var scheme = {
Expand Down Expand Up @@ -263,5 +287,9 @@ function assert(bemjson, html, templates, options) {
return bundle.runTechAndRequire(bhServer, options)
.spread(function (bh) {
bh.apply(bemjson).must.be(html);

options && options.mimic && [].concat(options.mimic).forEach(function (name) {
bh[name].apply(bemjson).must.be(html);
});
});
}