Skip to content

Commit 9a33208

Browse files
bmuenzenmeyerbmuenzenmeyer
committed
added deprecation warning to setState
removed it from all unit tests
1 parent d554e8d commit 9a33208

File tree

3 files changed

+20
-111
lines changed

3 files changed

+20
-111
lines changed

‎core/lib/pattern_assembler.js

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,17 @@ var pattern_assembler = function () {
6868

6969
/*
7070
* Deprecated in favor of .md 'status' frontmatter inside a pattern. Still used for unit tests at this time.
71+
* Will be removed in future versions
7172
*/
72-
function setState(pattern, patternlab) {
73+
function setState(pattern, patternlab, displayDeprecatedWarning) {
7374
if (patternlab.config.patternStates && patternlab.config.patternStates[pattern.patternPartial]) {
75+
76+
if (displayDeprecatedWarning) {
77+
plutils.logRed("Deprecation Warning: Using patternlab-config.json patternStates object will be deprecated in favor of the state frontmatter key associated with individual pattern markdown files.");
78+
console.log("This feature will still work in it's current form this release (but still be overridden by the new parsing method), and will be removed in the future.");
79+
}
80+
7481
pattern.patternState = patternlab.config.patternStates[pattern.patternPartial];
75-
} else {
76-
pattern.patternState = "";
7782
}
7883
}
7984

@@ -200,7 +205,7 @@ var pattern_assembler = function () {
200205
}
201206

202207
//see if this file has a state
203-
//setState(currentPattern, patternlab);
208+
setState(currentPattern, patternlab, true);
204209

205210
//look for a json file for this template
206211
try {
@@ -412,8 +417,8 @@ var pattern_assembler = function () {
412417
find_list_items: function (pattern) {
413418
return pattern.findListItems();
414419
},
415-
setPatternState: function (pattern, patternlab) {
416-
setState(pattern, patternlab);
420+
setPatternState: function (pattern, patternlab, displayDeprecatedWarning) {
421+
setState(pattern, patternlab, displayDeprecatedWarning);
417422
},
418423
addPattern: function (pattern, patternlab) {
419424
addPattern(pattern, patternlab);

‎test/lineage_hunter_tests.js

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -159,22 +159,18 @@ exports['lineage hunter '] = {
159159
'cascade_pattern_states promotes a lower pattern state up to the consumer': function (test) {
160160
//arrange
161161
var pl = createBasePatternLabObject();
162-
pl.config.patternStates = {
163-
"test-foo": "complete",
164-
"test-bar": "inreview"
165-
};
166162

167163
var atomPattern = new of.Pattern('00-test/01-bar.mustache');
168164
atomPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/01-bar.mustache', 'utf8');
169165
atomPattern.extendedTemplate = atomPattern.template;
166+
atomPattern.patternState = "inreview";
170167

171-
pattern_assembler.setPatternState(atomPattern, pl);
172168
pattern_assembler.addPattern(atomPattern, pl);
173169

174170
var consumerPattern = new of.Pattern('00-test/00-foo.mustache');
175171
consumerPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/00-foo.mustache', 'utf8');
176172
consumerPattern.extendedTemplate = consumerPattern.template;
177-
pattern_assembler.setPatternState(consumerPattern, pl);
173+
consumerPattern.patternState = "complete";
178174
pattern_assembler.addPattern(consumerPattern, pl);
179175

180176
lineage_hunter.find_lineage(consumerPattern, pl);
@@ -191,22 +187,18 @@ exports['lineage hunter '] = {
191187
'cascade_pattern_states promotes a lower pattern state up to the consumers lineage': function (test) {
192188
//arrange
193189
var pl = createBasePatternLabObject();
194-
pl.config.patternStates = {
195-
"test-foo": "complete",
196-
"test-bar": "inreview"
197-
};
198190

199191
var atomPattern = new of.Pattern('00-test/01-bar.mustache');
200192
atomPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/01-bar.mustache', 'utf8');
201193
atomPattern.extendedTemplate = atomPattern.template;
194+
atomPattern.patternState = "inreview";
202195

203-
pattern_assembler.setPatternState(atomPattern, pl);
204196
pattern_assembler.addPattern(atomPattern, pl);
205197

206198
var consumerPattern = new of.Pattern('00-test/00-foo.mustache');
207199
consumerPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/00-foo.mustache', 'utf8');
208200
consumerPattern.extendedTemplate = consumerPattern.template;
209-
pattern_assembler.setPatternState(consumerPattern, pl);
201+
consumerPattern.patternState = "complete";
210202
pattern_assembler.addPattern(consumerPattern, pl);
211203

212204
lineage_hunter.find_lineage(consumerPattern, pl);
@@ -223,22 +215,17 @@ exports['lineage hunter '] = {
223215
'cascade_pattern_states sets the pattern state on any lineage patterns reverse lineage': function (test) {
224216
//arrange
225217
var pl = createBasePatternLabObject();
226-
pl.config.patternStates = {
227-
"test-foo": "complete",
228-
"test-bar": "inreview"
229-
};
230218

231219
var atomPattern = new of.Pattern('00-test/01-bar.mustache');
232220
atomPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/01-bar.mustache', 'utf8');
233221
atomPattern.extendedTemplate = atomPattern.template;
234-
235-
pattern_assembler.setPatternState(atomPattern, pl);
222+
atomPattern.patternState = "inreview";
236223
pattern_assembler.addPattern(atomPattern, pl);
237224

238225
var consumerPattern = new of.Pattern('00-test/00-foo.mustache');
239226
consumerPattern.template = fs.readFileSync(pl.config.paths.source.patterns + '00-test/00-foo.mustache', 'utf8');
240227
consumerPattern.extendedTemplate = consumerPattern.template;
241-
pattern_assembler.setPatternState(consumerPattern, pl);
228+
consumerPattern.patternState = "complete";
242229
pattern_assembler.addPattern(consumerPattern, pl);
243230

244231
lineage_hunter.find_lineage(consumerPattern, pl);
@@ -256,21 +243,17 @@ exports['lineage hunter '] = {
256243
'cascade_pattern_states promotes lower pattern state when consumer does not have its own state': function (test) {
257244
//arrange
258245
var pl = createBasePatternLabObject();
259-
pl.config.patternStates = {
260-
"test-bar": "inreview"
261-
};
262246

263247
var atomPattern = new of.Pattern('00-test/01-bar.mustache');
264248
atomPattern.template = fs.readFileSync(path.resolve(pl.config.paths.source.patterns, '00-test/01-bar.mustache'), 'utf8');
265249
atomPattern.extendedTemplate = atomPattern.template;
250+
atomPattern.patternState = "inreview";
266251

267-
pattern_assembler.setPatternState(atomPattern, pl);
268252
pattern_assembler.addPattern(atomPattern, pl);
269253

270254
var consumerPattern = new of.Pattern('00-test/00-foo.mustache');
271255
consumerPattern.template = fs.readFileSync(path.resolve(pl.config.paths.source.patterns, '00-test/00-foo.mustache'), 'utf8');
272256
consumerPattern.extendedTemplate = consumerPattern.template;
273-
pattern_assembler.setPatternState(consumerPattern, pl);
274257
pattern_assembler.addPattern(consumerPattern, pl);
275258

276259
lineage_hunter.find_lineage(consumerPattern, pl);

‎test/pattern_assembler_tests.js

Lines changed: 2 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -6,86 +6,6 @@
66
var path = require('path');
77

88
exports['pattern_assembler'] = {
9-
10-
//'find_pattern_partials_with_parameters finds parameters' : function(test){
11-
//test.expect(2);
12-
//
13-
// //setup current pattern from what we would have during execution
14-
//var currentPattern = new Pattern(
15-
// '01-molecules/00-testing/00-test-mol.mustache', // relative path now
16-
// null // data
17-
//);
18-
// currentPattern.template = "<h1>{{> molecules-comment-header}}</h1><div>{{> molecules-single-comment(bar:'baz') }}</div>";
19-
//
20-
//var results = currentPattern.findPartialsWithPatternParameters();
21-
// test.equals(results.length, 1);
22-
// test.equals(results[0], "{{> molecules-single-comment(bar:'baz') }}");
23-
//
24-
// test.done();
25-
//
26-
//},
27-
//'find_pattern_partials_with_parameters finds parameters when stylemodifiers present too' : function(test){
28-
//test.expect(2);
29-
//
30-
// //setup current pattern from what we would have during execution
31-
//var currentPattern = new Pattern(
32-
// '01-molecules/00-testing/00-test-mol.mustache', // relative path now
33-
// null // data
34-
//);
35-
// currentPattern.template = "<h1>{{> molecules-comment-header}}</h1><div>{{> molecules-single-comment:foo(bar:'baz') }}</div>";
36-
//
37-
//var results = currentPattern.findPartialsWithPatternParameters();
38-
// test.equals(results.length, 1);
39-
// test.equals(results[0], "{{> molecules-single-comment:foo(bar:'baz') }}");
40-
//
41-
// test.done();
42-
//},
43-
//'find_pattern_partials_with_parameters finds parameters with verbose partials' : function(test){
44-
//test.expect(2);
45-
//
46-
// //setup current pattern from what we would have during execution
47-
//var currentPattern = new Pattern(
48-
// '01-molecules/00-testing/00-test-mol.mustache', // relative path now
49-
// null // data
50-
//);
51-
// currentPattern.template = "<h1>{{> 01-molecules/06-components/molecules-comment-header}}</h1><div>{{> 01-molecules/06-components/molecules-single-comment(bar:'baz') }}</div>";
52-
//
53-
//var results = currentPattern.findPartialsWithPatternParameters();
54-
// test.equals(results.length, 1);
55-
// test.equals(results[0], "{{> 01-molecules/06-components/molecules-single-comment(bar:'baz') }}");
56-
//
57-
// test.done();
58-
//},
59-
//'find_pattern_partials_with_parameters finds no style modifiers when only partials present' : function(test){
60-
//test.expect(1);
61-
//
62-
// //setup current pattern from what we would have during execution
63-
//var currentPattern = new Pattern(
64-
// '01-molecules/00-testing/00-test-mol.mustache', // relative path now
65-
// null // data
66-
//);
67-
// currentPattern.template = "<h1>{{> molecules-comment-header}}</h1><div>{{> molecules-single-comment }}</div>";
68-
//
69-
//var results = currentPattern.findPartialsWithPatternParameters();
70-
// test.equals(results, null);
71-
//
72-
// test.done();
73-
//},
74-
//'find_pattern_partials_with_parameters finds no style modifiers when only partials with style modifiers present' : function(test){
75-
//test.expect(1);
76-
//
77-
// //setup current pattern from what we would have during execution
78-
//var currentPattern = new Pattern(
79-
// '01-molecules/00-testing/00-test-mol.mustache', // relative path now
80-
// null // data
81-
//);
82-
// currentPattern.template = "<h1>{{> molecules-comment-header}}</h1><div>{{> molecules-single-comment:foo }}</div>";
83-
//
84-
//var results = currentPattern.findPartialsWithPatternParameters();
85-
// test.equals(results, null);
86-
//
87-
// test.done();
88-
//},
899
'process_pattern_recursive recursively includes partials' : function(test){
9010
test.expect(3);
9111

@@ -413,7 +333,8 @@
413333
patternlab.config.patternStates["pages-homepage-emergency"] = "inprogress";
414334

415335
var pattern = {
416-
key: "pages-homepage"
336+
key: "pages-homepage",
337+
patternState: ""
417338
};
418339

419340
//act

0 commit comments

Comments
 (0)