Skip to content

Commit d401904

Browse files
author
Brian Muenzenmeyer
committed
Merge pull request #346 from pattern-lab/patternName-rename
refactor patternName per styleguidekit-mustache-default key mismatch
2 parents c87cdfc + 452748c commit d401904

File tree

8 files changed

+26
-32
lines changed

8 files changed

+26
-32
lines changed

‎core/lib/list_item_hunter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ var list_item_hunter = function () {
3434
var repeatedBlockHtml = '';
3535
for (var i = 0; i < items.indexOf(loopNumberString); i++) {
3636
if (patternlab.config.debug) {
37-
console.log('list item(s) in pattern', pattern.patternName, 'adding', patternBlock, 'to repeatedBlockTemplate');
37+
console.log('list item(s) in pattern', pattern.patternPartial, 'adding', patternBlock, 'to repeatedBlockTemplate');
3838
}
3939
repeatedBlockTemplate.push(patternBlock);
4040
}

‎core/lib/object_factory.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ var Pattern = function (relPath, data) {
2222
this.jsonFileData = data || {};
2323

2424
// strip leading "00-" from the file name and flip tildes to dashes
25-
this.patternName = this.fileName.replace(/^\d*\-/, '').replace('~', '-'); // 'colors'
25+
this.patternBaseName = this.fileName.replace(/^\d*\-/, '').replace('~', '-'); // 'colors'
2626

2727
// Fancy name. No idea how this works. 'Colors'
28-
this.patternDisplayName = this.patternName.split('-').reduce(function (val, working) {
28+
this.patternName = this.patternBaseName.split('-').reduce(function (val, working) {
2929
return val.charAt(0).toUpperCase() + val.slice(1) + ' ' + working.charAt(0).toUpperCase() + working.slice(1);
3030
}, '').trim(); //this is the display name for the ui. strip numeric + hyphen prefixes
3131

@@ -44,7 +44,7 @@ var Pattern = function (relPath, data) {
4444

4545
// The canonical "key" by which this pattern is known. This is the callable
4646
// name of the pattern. UPDATE: this.key is now known as this.patternPartial
47-
this.patternPartial = this.patternGroup + '-' + this.patternName;
47+
this.patternPartial = this.patternGroup + '-' + this.patternBaseName;
4848

4949
this.template = '';
5050
this.patternPartialCode = '';

‎core/lib/pattern_assembler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ var pattern_assembler = function () {
7676
function addPattern(pattern, patternlab) {
7777

7878
//add the link to the global object
79-
patternlab.data.link[pattern.patternGroup + '-' + pattern.patternName] = '/patterns/' + pattern.patternLink;
79+
patternlab.data.link[pattern.patternGroup + '-' + pattern.patternBaseName] = '/patterns/' + pattern.patternLink;
8080

8181
//only push to array if the array doesn't contain this pattern
8282
var isNew = true;

‎core/lib/patternlab.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ var patternlab_engine = function (config) {
275275
lineageR: pattern.patternLineagesR,
276276
patternLineageEExists: pattern.patternLineageExists || pattern.patternLineageRExists,
277277
patternDesc: pattern.patternDescExists ? pattern.patternDesc : '',
278-
patternBreadcrumb: 'TODO',
278+
patternBreadcrumb: pattern.patternGroup,
279279
patternExtension: pattern.fileExtension,
280280
patternName: pattern.patternName,
281281
patternPartial: pattern.patternPartial,

‎core/lib/ui_builder.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ var eol = require('os').EOL;
1111

1212
function addToPatternPaths(patternlab, patternTypeName, pattern) {
1313
//this is messy, could use a refactor.
14-
patternlab.patternPaths[patternTypeName][pattern.patternName] = pattern.subdir.replace(/\\/g, '/') + "/" + pattern.fileName;
14+
patternlab.patternPaths[patternTypeName][pattern.patternBaseName] = pattern.subdir.replace(/\\/g, '/') + "/" + pattern.fileName;
1515
}
1616

1717
//todo: refactor this as a method on the pattern object itself once we merge dev with pattern-engines branch

‎test/lineage_hunter_tests.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ exports['lineage hunter '] = {
6161
"data": null,
6262
"template": "<a href=\"/\"><img src=\"../../images/logo.png\" class=\"logo\" alt=\"Logo Alt Text\" /></a>",
6363
"patternPartialCode": "<a href=\"/\"><img src=\"../../images/logo.png\" class=\"logo\" alt=\"Logo Alt Text\" /></a>",
64-
"patternName": "logo",
64+
"patternBaseName": "logo",
6565
"patternLink": "00-atoms-03-images-00-logo/00-atoms-03-images-00-logo.html",
6666
"patternGroup": "atoms",
6767
"patternSubGroup": "atoms\\03-images",
@@ -80,7 +80,7 @@ exports['lineage hunter '] = {
8080
"data": null,
8181
"template": "<nav id=\"nav\" class=\"nav\">\r\n\t<ul>\r\n\t\t<li><a href=\"#\">Home</a></li>\r\n\t\t<li><a href=\"#\">About</a></li>\r\n\t\t<li><a href=\"#\">Blog</a></li>\r\n\t\t<li><a href=\"#\">Contact</a></li>\r\n\t</ul>\r\n</nav><!--end .nav-->\r\n",
8282
"patternPartialCode": "<nav id=\"nav\" class=\"nav\">\r\n\t<ul>\r\n\t\t<li><a href=\"#\">Home</a></li>\r\n\t\t<li><a href=\"#\">About</a></li>\r\n\t\t<li><a href=\"#\">Blog</a></li>\r\n\t\t<li><a href=\"#\">Contact</a></li>\r\n\t</ul>\r\n</nav><!--end .nav-->\r\n",
83-
"patternName": "primary-nav",
83+
"patternBaseName": "primary-nav",
8484
"patternLink": "01-molecules-05-navigation-00-primary-nav/01-molecules-05-navigation-00-primary-nav.html",
8585
"patternGroup": "molecules",
8686
"patternSubGroup": "molecules\\05-navigation",
@@ -99,7 +99,7 @@ exports['lineage hunter '] = {
9999
"data": null,
100100
"template": "<form action=\"#\" method=\"post\" class=\"inline-form search-form\"> \r\n <fieldset>\r\n\t <legend class=\"is-vishidden\">Search</legend>\r\n\t <label for=\"search-field\" class=\"is-vishidden\">Search</label>\r\n\t <input type=\"search\" placeholder=\"Search\" id=\"search-field\" class=\"search-field\" />\r\n\t <button class=\"search-submit\">\r\n\t \t<span class=\"icon-search\" aria-hidden=\"true\"></span>\r\n\t \t<span class=\"is-vishidden\">Search</span>\r\n\t </button>\r\n </fieldset>\r\n</form>",
101101
"patternPartialCode": "<form action=\"#\" method=\"post\" class=\"inline-form search-form\"> \r\n <fieldset>\r\n\t <legend class=\"is-vishidden\">Search</legend>\r\n\t <label for=\"search-field\" class=\"is-vishidden\">Search</label>\r\n\t <input type=\"search\" placeholder=\"Search\" id=\"search-field\" class=\"search-field\" />\r\n\t <button class=\"search-submit\">\r\n\t \t<span class=\"icon-search\" aria-hidden=\"true\"></span>\r\n\t \t<span class=\"is-vishidden\">Search</span>\r\n\t </button>\r\n </fieldset>\r\n</form>",
102-
"patternName": "search",
102+
"patternBaseName": "search",
103103
"patternLink": "01-molecules-04-forms-00-search/01-molecules-04-forms-00-search.html",
104104
"patternGroup": "molecules",
105105
"patternSubGroup": "molecules\\04-forms",
@@ -303,7 +303,7 @@ exports['lineage hunter '] = {
303303
"data": null,
304304
"template": "<h1> {{message}} </h1>",
305305
"extendedTemplate": "<h1> {{message}} </h1>",
306-
"patternName": "error",
306+
"patternBaseName": "error",
307307
"patternLink": "01-atoms-05-alerts-00-error/01-atoms-05-alerts-00-error.html",
308308
"patternGroup": "atoms",
309309
"patternSubGroup": "atoms\\05-alerts",
@@ -338,7 +338,7 @@ exports['lineage hunter '] = {
338338
"data": null,
339339
"template": "{{> atoms-error:foo }}",
340340
"extendedTemplate": "{{> atoms-error:foo }}",
341-
"patternName": "error",
341+
"patternBaseName": "error",
342342
"patternLink": "01-molecules-01-toast-00-error/01-molecules-01-toast-00-error.html",
343343
"patternGroup": "molecules",
344344
"patternSubGroup": "molecules\\01-toast",
@@ -359,7 +359,7 @@ exports['lineage hunter '] = {
359359
"data": null,
360360
"template": "<h1> {{message}} </h1>",
361361
"extendedTemplate": "<h1> {{message}} </h1>",
362-
"patternName": "error",
362+
"patternBaseName": "error",
363363
"patternLink": "01-atoms-05-alerts-00-error/01-atoms-05-alerts-00-error.html",
364364
"patternGroup": "atoms",
365365
"patternSubGroup": "atoms\\05-alerts",
@@ -392,7 +392,7 @@ exports['lineage hunter '] = {
392392
"data": null,
393393
"template": "{{> atoms-error:foo }}",
394394
"extendedTemplate": "{{>atoms-error:foo}}",
395-
"patternName": "error",
395+
"patternBaseName": "error",
396396
"patternLink": "01-molecules-01-toast-00-error/01-molecules-01-toast-00-error.html",
397397
"patternGroup": "molecules",
398398
"patternSubGroup": "molecules\\01-toast",
@@ -413,7 +413,7 @@ exports['lineage hunter '] = {
413413
"data": null,
414414
"template": "<h1> {{message}} </h1>",
415415
"extendedTemlpate": "<h1> {{message}} </h1>",
416-
"patternName": "error",
416+
"patternBaseName": "error",
417417
"patternLink": "01-atoms-05-alerts-00-error/01-atoms-05-alerts-00-error.html",
418418
"patternGroup": "atoms",
419419
"patternSubGroup": "atoms\\05-alerts",
@@ -446,7 +446,7 @@ exports['lineage hunter '] = {
446446
"data": null,
447447
"template": "{{> atoms-e:foo }}",
448448
"extendedTemplate": "{{>atoms-e:foo}}",
449-
"patternName": "error",
449+
"patternBaseName": "error",
450450
"patternLink": "01-molecules-01-toast-00-error/01-molecules-01-toast-00-error.html",
451451
"patternGroup": "molecules",
452452
"patternSubGroup": "molecules\\01-toast",
@@ -467,7 +467,7 @@ exports['lineage hunter '] = {
467467
"data": null,
468468
"template": "<h1> {{message}} </h1>",
469469
"extendedTemplate": "<h1> {{message}} </h1>",
470-
"patternName": "error",
470+
"patternBaseName": "error",
471471
"patternLink": "01-atoms-05-alerts-00-error/01-atoms-05-alerts-00-error.html",
472472
"patternGroup": "atoms",
473473
"patternSubGroup": "atoms\\05-alerts",
@@ -507,7 +507,7 @@ exports['lineage hunter '] = {
507507
"data": null,
508508
"template": "<h1> {{message}} </h1>",
509509
"extendedTemplate": "<h1> {{message}} </h1>",
510-
"patternName": "error",
510+
"patternBaseName": "error",
511511
"patternLink": "01-atoms-05-alerts-00-error/01-atoms-05-alerts-00-error.html",
512512
"patternGroup": "atoms",
513513
"patternSubGroup": "atoms\\05-alerts",

‎test/object_factory_tests.js

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
test.equals(p.fileName, '00-colors');
1414
test.equals(p.fileExtension, '.mustache');
1515
test.equals(p.jsonFileData.d, 123);
16-
test.equals(p.patternName, 'colors');
17-
test.equals(p.patternDisplayName, 'Colors');
16+
test.equals(p.patternBaseName, 'colors');
17+
test.equals(p.patternName, 'Colors');
1818
test.equals(p.patternLink, '00-atoms-00-global-00-colors/00-atoms-00-global-00-colors.html');
1919
test.equals(p.patternGroup, 'atoms');
2020
test.equals(p.patternSubGroup, 'global');
@@ -36,8 +36,8 @@
3636
test.equals(p.fileName, '00-colors');
3737
test.equals(p.fileExtension, '.mustache');
3838
test.equals(p.jsonFileData.d, 123);
39-
test.equals(p.patternName, 'colors');
40-
test.equals(p.patternDisplayName, 'Colors');
39+
test.equals(p.patternBaseName, 'colors');
40+
test.equals(p.patternName, 'Colors');
4141
test.equals(p.patternLink, '00-atoms-00-colors/00-atoms-00-colors.html');
4242
test.equals(p.patternGroup, 'atoms');
4343
test.equals(p.flatPatternPath, '00-atoms');
@@ -51,14 +51,8 @@
5151
},
5252
'test Pattern capitalizes patternDisplayName correctly' : function(test){
5353
var p = new Pattern('00-atoms/00-global/00-colors-alt.mustache', { d: 123});
54-
test.equals(p.patternName, 'colors-alt');
55-
test.equals(p.patternDisplayName, 'Colors Alt');
56-
test.done();
57-
},
58-
'test Pattern removes pattern paramter from key correctly' : function(test){
59-
var p = new Pattern('00-atoms/00-global/00-colors-alt.mustache', { d: 123});
60-
test.equals(p.patternName, 'colors-alt');
61-
test.equals(p.patternDisplayName, 'Colors Alt');
54+
test.equals(p.patternBaseName, 'colors-alt');
55+
test.equals(p.patternName, 'Colors Alt');
6256
test.done();
6357
}
6458
};

‎test/parameter_hunter_tests.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"fileName": "01-sticky-comment",
1010
"subdir": "02-organisms/02-comments",
1111
"name": "02-organisms-02-comments-01-sticky-comment",
12-
"patternName": "sticky-comment",
12+
"patternBaseName": "sticky-comment",
1313
"patternLink": "02-organisms-02-comments-01-sticky-comment/02-organisms-02-comments-01-sticky-comment.html",
1414
"patternGroup": "organisms",
1515
"patternSubGroup": "comments",
@@ -31,7 +31,7 @@
3131
"fileName": "02-single-comment",
3232
"subdir": "01-molecules/06-components",
3333
"name": "01-molecules-06-components-02-single-comment",
34-
"patternName": "single-comment",
34+
"patternBaseName": "single-comment",
3535
"patternLink": "01-molecules-06-components-02-single-comment/01-molecules-06-components-02-single-comment.html",
3636
"patternGroup": "molecules",
3737
"patternSubGroup": "components",

0 commit comments

Comments
 (0)