@penskemediacorp/larva 1.2.0-alpha.0 → 1.3.0

package/__tests__/lib/utils/getPatternRoutes.test.js

@@ -0,0 +1,29 @@
+const path = require( 'path' );
+const fixture = path.join( __dirname, '../../fixtures' );
+
+const getAllPatternsObj = require( '../../../lib/utils/getAllPatternsObj' );
+const getPatternRoutes = require( '../../../lib/utils/getPatternRoutes' );
+
+describe( 'getPatternRoutes', () => {
+
+	it( 'outputs an array of routes from a pattern object', () => {
+
+		const patterns = getAllPatternsObj( path.join( fixture, 'src/patterns' ) );
+
+		const expected = [
+			'components/c-nav-link/featured.aia',
+			'components/c-nav-link/featured',
+			'components/c-nav-link',
+			'components/c-tagline',
+			'modules/test-module/featured',
+			'modules/test-module',
+			'objects/o-crap',
+			'objects/o-nav',
+			'one-offs/newswire'
+		];
+
+		expect( getPatternRoutes( patterns ) ).toStrictEqual( expected );
+
+	} );
+
+} );

package/__tests__/lib/utils/getPatternType.test.js

@@ -0,0 +1,16 @@
+const getPatternType = require( '../../../lib/utils/getPatternType' );
+const assert = require( 'assert' );
+
+describe( 'getPatternType', () => {
+	it( 'returns components for c-', () => {
+		assert.equal( getPatternType( 'c-nav-item' ), 'components' );
+	});
+
+	it( 'returns objects for o-', () => {
+		assert.equal( getPatternType( 'o-nav' ), 'objects' );
+	});
+
+	it( 'returns modules for no namespace', () => {
+		assert.equal( getPatternType( 'breadcrumbs' ), 'modules' );
+	});
+});

package/__tests__/lib/utils/getPatternVariants.test.js

@@ -0,0 +1,20 @@
+const path = require( 'path' );
+const getAppConfiguration = require( '../../../lib/utils/getAppConfiguration' );
+const getPatternVariants = require( '../../../lib/utils/getPatternVariants' );
+
+const config = getAppConfiguration( 'patterns' );
+
+describe( 'getPatternVariants', () => {
+
+	it( 'returns an array of variants', () => {
+		expect( 
+			getPatternVariants( path.join( config.projectPatternsDir, 'components/c-nav-link/' ) )
+		 ).toEqual( 
+			[
+				'featured.aia',
+				'featured',
+				'prototype'
+			]
+		);
+	});
+});

package/__tests__/lib/utils/getPatternsIndexPath.test.js

@@ -0,0 +1,9 @@
+const assert = require( 'assert' );
+const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )('patterns');
+const getPatternsIndexPath = require( '../../../lib/utils/getPatternsIndexPath' );
+
+describe( 'getPatternsIndexPath', () => {
+	it( 'gets the path for larva if it is the core theme', () => {
+		assert.equal( getPatternsIndexPath( appConfiguration ).includes( 'larva' ), true );
+	});
+});

package/__tests__/lib/utils/getSubDirectoryNames.test.js

@@ -0,0 +1,17 @@
+const assert = require( 'assert' );
+const getPatternsList = require( '../../../lib/utils/getSubDirectoryNames' );
+const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )('patterns');
+const expectedObjectsList = [ 'o-crap', 'o-nav' ];
+const expectedComponentsList = [ 'c-nav-link', 'c-tagline' ];
+
+console.log( appConfiguration.projectPatternsDir );
+
+describe( 'getSubDirectoryNames', () => {
+	it( 'gets an array of subdir names for objects', () => {
+		assert.deepEqual( getPatternsList( appConfiguration.projectPatternsDir + '/objects' ), expectedObjectsList );
+	});
+
+	it( 'gets an array of subdir names for components', () => {
+		assert.deepEqual( getPatternsList( appConfiguration.projectPatternsDir + '/components' ), expectedComponentsList );
+	});
+});

package/__tests__/lib/utils/isCoreTheme.test.js

@@ -0,0 +1,12 @@
+const assert = require( 'assert' );
+const isCoreTheme = require( '../../../lib/utils/isCoreTheme' );
+const appConfiguration = require( '../../../lib/utils/getAppConfiguration' )('patterns');
+
+describe( 'isCoreTheme', () => {
+	// TODO:
+	// Leaving this as a failing test as a reminder to finalize what the core theme logic is,
+	// and if it is necessary other than in the parser.
+	it( 'is the core theme if there is no configuration for themePatternsDir', () => {
+		assert.equal( isCoreTheme( appConfiguration ), true );
+	});
+});

package/__tests__/lib/utils/writeJsonToFile.test.js

@@ -0,0 +1,29 @@
+const assert = require( 'assert' );
+const fs = require( 'fs' );
+const path = require( 'path' );
+const getPatternData = require( '../../../lib/utils/getPatternData' );
+const fixture = path.join( __dirname, '../../fixtures/src/patterns' );
+const writeJson = require( '../../../lib/utils/writeJsonToFile' );
+const exec = require( 'child_process' ).exec;
+const expectedData = '{"o_crap_classes":"hello class here"}';
+
+describe( 'writeJsonToFile', () => {
+	
+	let data = getPatternData( fixture, { type: 'objects', name: 'o-crap' } );
+	writeJson( fixture + '/data.json', data );
+	
+	it( 'writes o-crap json to a file', () => {
+		let data = fs.readFileSync( fixture + '/data.json' ).toString();
+
+		assert.equal( data, expectedData );
+	});
+
+	afterAll( () => {
+		exec( 'rm ' + fixture + '/data.json', ( err  ) => {
+			if ( err ) {
+				console.error( err );
+			}
+		});
+	});
+
+});

package/__tests__/lib/writeJson.test.js

@@ -0,0 +1,83 @@
+const assert = require( 'assert' );
+const path = require( 'path' );
+const fs = require( 'fs' );
+const exec = require( 'child_process' ).exec;
+
+const fixture = path.join( __dirname, '../fixtures' );
+const getAppConfiguration = require( '../../lib/utils/getAppConfiguration' );
+const writeJson = require( '../../lib/writeJson' );
+const patternConfig = getAppConfiguration( 'patterns' );
+
+const expectedJsonPath = path.join( fixture, './build/json/modules/' );
+
+describe( 'writeJson', () => {
+	let testJsonPath = path.join( expectedJsonPath, 'test-module.prototype.json' );
+	let testPrototypePath = path.join( fixture, './src/patterns/modules/test-module/test-module.prototype.js' );
+	let testVariantJsonPath = path.join( expectedJsonPath, 'test-module.featured.json' );
+	let testIgnoredJsonPath = path.join( expectedJsonPath, 'ignore-me.prototype.json' );
+
+	beforeAll( ( done ) => {
+		exec( 'mkdirp ' + expectedJsonPath, ( err ) => {
+			if ( err ) {
+				console.error( err );
+				done();
+			} else {
+				writeJson( patternConfig );
+				done();
+			}
+		});
+	});
+
+	it( 'creates a JSON file', () => {
+		assert.equal( fs.existsSync( testJsonPath ), true );
+	});
+
+	it( 'prototype JS file equals JSON contents', () => {
+		assert.equal( JSON.stringify( require( testPrototypePath ) ), JSON.stringify( require( testJsonPath ) ) );
+	});
+
+	it( 'does not write JSON for ignored modules', () => {
+		assert.equal( fs.existsSync( testIgnoredJsonPath ), false );
+	});
+
+	it( 'creates a variant JSON', () => {
+		assert.equal( fs.existsSync( testVariantJsonPath ), true );
+	});
+
+	afterAll( ( done ) => {
+		exec( 'rm -r ' + path.join( expectedJsonPath ), ( err ) => {
+			if ( err ) {
+				console.error( err );
+			}
+			done();
+		});
+	});
+});
+
+describe( 'writeJson from Larva', () => {
+	let testJsonPath = path.join( expectedJsonPath, 'pmc-footer.prototype.json' );
+
+	beforeAll( ( done ) => {
+		exec( 'mkdirp ' + expectedJsonPath, ( err ) => {
+			if ( err ) {
+				console.error( err );
+			} else {
+				writeJson( patternConfig, true );
+				done();
+			}
+		});
+	});
+
+	it( 'creates a JSON file', () => {
+		assert.equal( fs.existsSync( testJsonPath ), true );
+	});
+
+	afterAll( ( done ) => {
+		exec( 'rm -r ' + path.join( expectedJsonPath ), ( err ) => {
+			if ( err ) {
+				console.error( err );
+			}
+			done();
+		});
+	});
+});

package/bin/larva.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require( 'fs' );
+const path = require( 'path' );
+const spawn = require( 'cross-spawn' );
+const chalk = require( 'chalk' );
+
+const getArgsFromCli = require( '../lib/utils/getArgsFromCli' );
+const cliArgs = getArgsFromCli();
+const scriptName = cliArgs[0];
+
+const hasScriptFile = fs.existsSync( path.join( __dirname, '../scripts/' + scriptName + '.js' ) );
+
+if ( hasScriptFile ) {
+	spawn.sync(
+		'node',
+		[
+			path.join( __dirname, `../scripts/${ scriptName }.js` ),
+			... cliArgs
+		], { stdio: 'inherit' }
+	);
+} else {
+	console.error( chalk.red( `No file found for "${ scriptName }".` ) );
+}