patternlab-node/test/pattern_assembler_tests.js at features/plugins · patternfly/patternlab-node

This repository was archived by the owner on Feb 5, 2025. It is now read-only.

History

526 lines (454 loc) · 21.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

(function () {

"use strict";

var pa = require('../core/lib/pattern_assembler');

var Pattern = require('../core/lib/object_factory').Pattern;

var path = require('path');

exports['pattern_assembler'] = {

'process_pattern_recursive recursively includes partials' : function(test){

test.expect(3);

//tests inclusion of partial that will be discovered by diveSync later in iteration than parent

//prepare to diveSync

var diveSync = require('diveSync');

var fs = require('fs-extra');

var pa = require('../core/lib/pattern_assembler');

var plMain = require('../core/lib/patternlab');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var patternlab = {};

patternlab.config = fs.readJSONSync('./patternlab-config.json');

patternlab.config.paths.source.patterns = patterns_dir;

patternlab.config.outputFileSuffixes = {rendered : ''};

//patternlab.data = fs.readJSONSync(path.resolve(patternlab.config.paths.source.data, 'data.json'));

patternlab.data = {};

//patternlab.listitems = fs.readJSONSync(path.resolve(patternlab.config.paths.source.data, 'listitems.json'));

patternlab.listitems = {};

//patternlab.header = fs.readFileSync(path.resolve(patternlab.config.paths.source.patternlabFiles, 'templates/pattern-header-footer/header.html'), 'utf8');

patternlab.header = '';

//patternlab.footer = fs.readFileSync(path.resolve(patternlab.config.paths.source.patternlabFiles, 'templates/pattern-header-footer/footer.html'), 'utf8');

patternlab.footer = '';

patternlab.patterns = [];

patternlab.data.link = {};

patternlab.partials = {};

//diveSync once to perform iterative populating of patternlab object

plMain.process_all_patterns_iterative(pattern_assembler, patterns_dir, patternlab);

//diveSync again to recursively include partials, filling out the

//extendedTemplate property of the patternlab.patterns elements

plMain.process_all_patterns_recursive(pattern_assembler, patterns_dir, patternlab);

//get test output for comparison

var foo = fs.readFileSync(patterns_dir + '/00-test/00-foo.mustache', 'utf8').trim();

var bar = fs.readFileSync(patterns_dir + '/00-test/01-bar.mustache', 'utf8').trim();

var fooExtended;

//get extended pattern

for(var i = 0; i < patternlab.patterns.length; i++){

if(patternlab.patterns[i].fileName === '00-foo'){

fooExtended = patternlab.patterns[i].extendedTemplate.trim();

break;

}

//check initial values

test.equals(foo, '{{> test-bar }}');

test.equals(bar, 'bar');

//test that 00-foo.mustache included partial 01-bar.mustache

test.equals(fooExtended, 'bar');

test.done();

'processPatternRecursive - correctly replaces all stylemodifiers when multiple duplicate patterns with different stylemodifiers found' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

var groupPattern = new Pattern('00-test/04-group.mustache');

groupPattern.template = fs.readFileSync(patterns_dir + '/00-test/04-group.mustache', 'utf8');

groupPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(groupPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(groupPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '04-group.mustache', pl, {});

//assert

var expectedValue = '<div class="test_group"> <span class="test_base test_1"> {{message}} </span> <span class="test_base test_2"> {{message}} </span> <span class="test_base test_3"> {{message}} </span> <span class="test_base test_4"> {{message}} </span> </div>';

test.equals(groupPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());

test.done();

'processPatternRecursive - correctly replaces multiple stylemodifier classes on same partial' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

atomPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(atomPattern);

var groupPattern = new Pattern('00-test/10-multiple-classes-numeric.mustache');

groupPattern.template = fs.readFileSync(patterns_dir + '/00-test/10-multiple-classes-numeric.mustache', 'utf8');

groupPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(groupPattern);

groupPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(groupPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(groupPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '10-multiple-classes-numeric.mustache', pl, {});

//assert

var expectedValue = '<div class="test_group"> <span class="test_base foo1"> {{message}} </span> <span class="test_base foo1 foo2"> {{message}} </span> <span class="test_base foo1 foo2"> bar </span> </div>';

test.equals(groupPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());

test.done();

'processPatternRecursive - correctly ignores a partial without a style modifier when the same partial later has a style modifier' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

var mixedPattern = new Pattern('00-test/06-mixed.mustache');

mixedPattern.template = fs.readFileSync(patterns_dir + '/00-test/06-mixed.mustache', 'utf8');

mixedPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(mixedPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(mixedPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '06-mixed.mustache', pl, {});

//assert. here we expect {{styleModifier}} to be in the first group, since it was not replaced by anything. rendering with data will then remove this (correctly)

var expectedValue = '<div class="test_group"> <span class="test_base {{styleModifier}}"> {{message}} </span> <span class="test_base test_2"> {{message}} </span> <span class="test_base test_3"> {{message}} </span> <span class="test_base test_4"> {{message}} </span> </div>';

test.equals(mixedPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());

test.done();

'processPatternRecursive - correctly ignores bookended partials without a style modifier when the same partial has a style modifier between' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

var bookendPattern = new Pattern('00-test/09-bookend.mustache');

bookendPattern.template = fs.readFileSync(patterns_dir + '/00-test/09-bookend.mustache', 'utf8');

bookendPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(bookendPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(bookendPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '09-bookend.mustache', pl, {});

//assert. here we expect {{styleModifier}} to be in the first and last group, since it was not replaced by anything. rendering with data will then remove this (correctly)

var actualValue = bookendPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ');

test.equals(actualValue.trim(), expectedValue.trim(), 'actual value:\n' + actualValue + '\nexpected value:\n' + expectedValue);

test.done();

'processPatternRecursive - correctly ignores a partial without a style modifier when the same partial later has a style modifier and pattern parameters' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

atomPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(atomPattern);

var mixedPattern = new Pattern('00-test/07-mixed-params.mustache');

mixedPattern.template = fs.readFileSync(patterns_dir + '/00-test/07-mixed-params.mustache', 'utf8');

mixedPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(mixedPattern);

mixedPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(mixedPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(mixedPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '07-mixed-params.mustache', pl, {});

//assert. here we expect {{styleModifier}} to be in the first span, since it was not replaced by anything. rendering with data will then remove this (correctly)

var expectedValue = '<div class="test_group"> <span class="test_base {{styleModifier}}"> {{message}} </span> <span class="test_base test_2"> 2 </span> <span class="test_base test_3"> 3 </span> <span class="test_base test_4"> 4 </span> </div>';

test.equals(mixedPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());

test.done();

'processPatternRecursive - correctly ignores bookended partials without a style modifier when the same partial has a style modifier and pattern parameters between' : function(test){

//arrange

var fs = require('fs-extra');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns';

var pl = {};

pl.config = {

paths: {

source: {

patterns: patterns_dir

}

outputFileSuffixes: {

rendered : ''

}

};

pl.data = {};

pl.data.link = {};

pl.config.debug = false;

pl.patterns = [];

pl.partials = {};

var atomPattern = new Pattern('00-test/03-styled-atom.mustache');

atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');

atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);

atomPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(atomPattern);

var bookendPattern = new Pattern('00-test/08-bookend-params.mustache');

bookendPattern.template = fs.readFileSync(patterns_dir + '/00-test/08-bookend-params.mustache', 'utf8');

bookendPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(bookendPattern);

bookendPattern.parameteredPartials = pattern_assembler.find_pattern_partials_with_parameters(bookendPattern);

pattern_assembler.addPattern(atomPattern, pl);

pattern_assembler.addPattern(bookendPattern, pl);

//act

pattern_assembler.process_pattern_recursive('00-test' + path.sep + '08-bookend-params.mustache', pl, {});

//assert. here we expect {{styleModifier}} to be in the first and last span, since it was not replaced by anything. rendering with data will then remove this (correctly)

test.equals(bookendPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());

test.done();

'setState - applies any patternState matching the pattern' : function(test){

//arrange

var pa = require('../core/lib/pattern_assembler');

var pattern_assembler = new pa();

var patternlab = {};

patternlab.config = {};

patternlab.config.patternStates = {};

patternlab.config.patternStates["pages-homepage-emergency"] = "inprogress";

var pattern = {

patternPartial: "pages-homepage-emergency"

};

//act

pattern_assembler.setPatternState(pattern, patternlab);

//assert

test.equals(pattern.patternState, "inprogress");

test.done();

'setState - does not apply any patternState if nothing matches the pattern' : function(test){

//arrange

var pa = require('../core/lib/pattern_assembler');

var pattern_assembler = new pa();

var patternlab = {};

patternlab.config = {};

patternlab.config.patternStates = {};

patternlab.config.patternStates["pages-homepage-emergency"] = "inprogress";

var pattern = {

key: "pages-homepage",

patternState: ""

};

//act

pattern_assembler.setPatternState(pattern, patternlab);

//assert

test.equals(pattern.patternState, "");

test.done();

'parseDataLinks - replaces found link.* data for their expanded links' : function(test){

//arrange

var diveSync = require('diveSync');

var fs = require('fs-extra');

var pa = require('../core/lib/pattern_assembler');

var plMain = require('../core/lib/patternlab');

var pattern_assembler = new pa();

var patterns_dir = './test/files/_patterns/';

var patternlab = {};

//THIS IS BAD

patternlab.config = fs.readJSONSync('./patternlab-config.json');

patternlab.config.paths.source.patterns = patterns_dir;

patternlab.config.outputFileSuffixes = { rendered : '' };

patternlab.data = {};

patternlab.listitems = {};

patternlab.header = {};

patternlab.footer = {};

//patternlab.data = fs.readJSONSync(path.resolve(patternlab.config.paths.source.data, 'data.json'));

//patternlab.listitems = fs.readJSONSync(path.resolve(patternlab.config.paths.source.data, 'listitems.json'));

//patternlab.header = fs.readFileSync(path.resolve(patternlab.config.paths.source.patternlabFiles, 'templates/pattern-header-footer/header.html'), 'utf8');

//patternlab.footer = fs.readFileSync(path.resolve(patternlab.config.paths.source.patternlabFiles, 'templates/pattern-header-footer/footer.html'), 'utf8');

patternlab.patterns = [

{

patternPartial: 'twitter-brad'

{

patternPartial: 'twitter-dave'

{

patternPartial: 'twitter-brian'

}

];

patternlab.data.link = {};

patternlab.partials = {};

//diveSync once to perform iterative populating of patternlab object

plMain.process_all_patterns_iterative(pattern_assembler, patterns_dir, patternlab);

//for the sake of the test, also imagining I have the following pages...

patternlab.data.link['twitter-brad'] = 'https://twitter.com/brad_frost';

patternlab.data.link['twitter-dave'] = 'https://twitter.com/dmolsen';

patternlab.data.link['twitter-brian'] = 'https://twitter.com/bmuenzenmeyer';

patternlab.data.brad = { url: "link.twitter-brad" };

patternlab.data.dave = { url: "link.twitter-dave" };

patternlab.data.brian = { url: "link.twitter-brian" };

var pattern;

for(var i = 0; i < patternlab.patterns.length; i++){

if(patternlab.patterns[i].patternPartial === 'test-nav'){

pattern = patternlab.patterns[i];

}

//assert before

test.equals(pattern.jsonFileData.brad.url, "link.twitter-brad");

test.equals(pattern.jsonFileData.dave.url, "link.twitter-dave");

test.equals(pattern.jsonFileData.brian.url, "link.twitter-brian");

//act

pattern_assembler.parse_data_links(patternlab);

//assert after

test.equals(pattern.jsonFileData.brad.url, "https://twitter.com/brad_frost");

test.equals(pattern.jsonFileData.dave.url, "https://twitter.com/dmolsen");

test.equals(pattern.jsonFileData.brian.url, "https://twitter.com/bmuenzenmeyer");

test.equals(patternlab.data.brad.url, "https://twitter.com/brad_frost");

test.equals(patternlab.data.dave.url, "https://twitter.com/dmolsen");

test.equals(patternlab.data.brian.url, "https://twitter.com/bmuenzenmeyer");

test.done();

'get_pattern_by_key - returns the fuzzy result when no others found' : function(test){

//arrange

var pattern_assembler = new pa();

var patternlab = {};

patternlab.patterns = [];

patternlab.patterns.push({

patternPartial: 'character-han-solo',

subdir: 'character',

fileName: 'han-solo'

});

//act

var result = pattern_assembler.getPartial('character-han', patternlab);

//assert

test.equals(result, patternlab.patterns[0]);

test.done();

'get_pattern_by_key - returns the exact key if found' : function(test){

//arrange

var pattern_assembler = new pa();

var patternlab = {};

patternlab.patterns = [];

patternlab.patterns.push({

patternPartial: 'molecules-primary-nav-jagged',

subdir: 'molecules',

fileName: 'primary-nav-jagged'

}, {

patternPartial: 'molecules-primary-nav',

subdir: 'molecules',

fileName: 'molecules-primary-nav'

});

//act

var result = pattern_assembler.getPartial('molecules-primary-nav', patternlab);

//assert

test.equals(result, patternlab.patterns[1]);

test.done();

'addPattern - adds pattern extended template to patternlab partial object' : function(test){

//arrange

var pattern_assembler = new pa();

var patternlab = {};

patternlab.patterns = [];

patternlab.partials = {};

patternlab.data = {link: {}};

patternlab.config = { debug: false };

patternlab.config.outputFileSuffixes = {rendered : ''};

var pattern = new Pattern('00-test/01-bar.mustache');

pattern.extendedTemplate = 'barExtended';

pattern.template = 'bar';

//act

pattern_assembler.addPattern(pattern, patternlab);

//assert

test.equals(patternlab.patterns.length, 1);

test.equals(patternlab.partials['test-bar'] != undefined, true);

test.equals(patternlab.partials['test-bar'], 'barExtended');

test.done();

'addPattern - adds pattern template to patternlab partial object if extendedtemplate does not exist yet' : function(test){

//arrange

var pattern_assembler = new pa();

var patternlab = {};

patternlab.patterns = [];

patternlab.partials = {};

patternlab.data = {link: {}};

patternlab.config = { debug: false };

patternlab.config.outputFileSuffixes = {rendered : ''};

var pattern = new Pattern('00-test/01-bar.mustache');

pattern.extendedTemplate = undefined;

pattern.template = 'bar';

//act

pattern_assembler.addPattern(pattern, patternlab);

//assert

test.equals(patternlab.patterns.length, 1);

test.equals(patternlab.partials['test-bar'] != undefined, true);

test.equals(patternlab.partials['test-bar'], 'bar');

test.done();

}

};

})();

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

pattern_assembler_tests.js

Latest commit

History

pattern_assembler_tests.js

File metadata and controls