@caweb/cli 1.13.7 → 1.14.0

package/lib/wordpress/caweb.js

@@ -1,114 +0,0 @@
-/**
- * External dependencies
- */
-import retry from '@wordpress/env/lib/retry.js';
-
-/**
- * Internal dependencies
- */
-import { CAWEB_OPTIONS } from'./options.js';
-import { runCLICmds } from'../helpers.js';
-import { isMultisite } from'./wordpress.js';
-import { configureDivi } from'./divi.js';
-
-/**
- * Activates the CAWeb Theme for the WordPress Environment if it's installed.
- * 
- * @param {string}		environment   Which environment to activate the theme on.
- * @param {WPConfig} 	config	      The wp-env config object.
- * @param {Object}   	spinner A CLI spinner which indicates progress.
- */
-async function activateCAWeb(
-	environment,
-	config,
-	spinner
-){
-
-	const isMulti = await isMultisite( environment, config , spinner);
-
-	let cmds = ['wp theme is-installed CAWeb'];
-
-	if( false !== isMulti ){
-		cmds.push( 'wp theme enable CAWeb --network --activate' );
-	}else{
-		cmds.push( 'wp theme activate CAWeb' );
-	}
-
-	return await runCLICmds(
-		environment,
-		cmds,
-		config,
-		spinner
-	);
-
-}
-
-/**
- * Configures CAWebPublishing Service for the given environment by configure settings,
- * and activating the CAWeb theme. These steps are
- * performed sequentially so as to not overload the WordPress instance.
- *
- * @param {WPEnvironment} environment The environment to configure. Either 'development' or 'tests'.
- * @param {WPConfig}      config      The wp-env config object.
- * @param {Object}        spinner     A CLI spinner which indicates progress.
- */
-async function configureCAWeb( environment, config, spinner ) {
-
-	const isThemeActivated = await activateCAWeb( environment, config );
-
-	// if our theme is active.
-	if( false !== isThemeActivated ){
-		
-		spinner.text = `Configuring CAWebPublishing ${environment} Environment...`;
-
-		// lets set the default theme to CAWeb.
-		let themeOptions = [
-			'wp config set WP_DEFAULT_THEME CAWeb',
-		];
-
-		// iterate over config options.
-		Object.entries(config.env[ environment ].config).forEach(([k,v]) => {
-			// if the option is prefixed with CAWEB_ and is a valid CAWeb Option.
-			if ( `${k}`.startsWith('CAWEB_') && undefined !== CAWEB_OPTIONS[k] ){
-				const option = CAWEB_OPTIONS[k];
-				// set the option.
-				themeOptions.push(
-					`wp option set '${option.name}' "${v}"`
-				);
-			}
-		})
-
-		if ( config.debug ) {
-			spinner.info(
-				`Running the following setup commands on the ${ environment } instance:\n - ${ setupCommands.join(
-					'\n - '
-				) }\n`
-			);
-		}
-		
-		// Execute theme option commands.
-		await runCLICmds(
-			environment,
-			themeOptions,
-			config,
-			spinner
-		);
-
-		// Make Divi WordPress Configurations.
-		await Promise.all( [
-			retry( () => configureDivi( 'development', config, spinner ), {
-				times: 2,
-			} ),
-			retry( () => configureDivi( 'tests', config, spinner ), {
-				times: 2,
-			} ),
-		] );
-
-	}
-	
-}
-
-export {
-	activateCAWeb,
-	configureCAWeb,
-};

package/lib/wordpress/divi.js

@@ -1,127 +0,0 @@
-/**
- * Internal dependencies
- */
-import { runCLICmds } from '../helpers.js';
-import { DIVI_OPTIONS } from './options.js';
-
-
-/**
- * Checks if Divi Theme is active for the WordPress Environment.
- * 
- * @param {string} 		environment Which environment to activate the theme on.
- * @param {WPConfig} 	config      The wp-env config object.
- * @param {Object}		spinner     A CLI spinner which indicates progress.
- */
-async function isDiviThemeActive(
-	environment,
-	config,
-	spinner
-){
-
-	return await runCLICmds(
-		environment,
-		['wp theme is-active Divi'],
-		config,
-		spinner
-	);
-
-}
-
-/**
- * Configures Divi for CAWebPublishing Service for the given environment by configure settings.
- * These steps are performed sequentially so as to not overload the WordPress instance.
- *
- * @param {WPEnvironment} environment The environment to configure. Either 'development' or 'tests'.
- * @param {WPConfig}      config      The wp-env config object.
- * @param {Object}        spinner     A CLI spinner which indicates progress.
- */
-async function configureDivi( environment, config, spinner ) {
-	
-	const activeTheme = await isDiviThemeActive( environment, config, spinner );
-
-	// if Divi theme is active.
-	if( false !== activeTheme ){
-		let cmds = [];
-		let diviOptions = await runCLICmds(
-			environment,
-			[ 'wp option get et_divi --format=json' ], 
-			config,
-			spinner
-		)
-		let diviBuilderOptions = await runCLICmds(
-			environment,
-			[ 'wp option get et_bfb_settings --format=json' ], 
-			config,
-			spinner
-		)
-		let diviUpdateOptions = await runCLICmds(
-			environment,
-			[ 'wp option get et_automatic_updates_options --format=json' ], 
-			config,
-			spinner
-		)
-
-		// parse the options into a json object.
-		diviOptions = typeof result === 'object' && ! diviOptions.exitCode ? JSON.parse( diviOptions ) : {};
-		diviBuilderOptions = typeof result === 'object' && ! diviBuilderOptions.exitCode ? JSON.parse( diviBuilderOptions ) : {};
-		diviUpdateOptions = typeof result === 'object' && ! diviUpdateOptions.exitCode ? JSON.parse( diviUpdateOptions ) : {};
-
-		// iterate over mapped Divi option groups.
-		Object.entries(DIVI_OPTIONS).forEach(([group, options]) => {
-			// iterate over each group options.
-			Object.entries(options).forEach(([key, data]) => {
-
-				// if user config has a Divi option variable use that, otherwise use our default.
-				let option_value = undefined !== config.env[ environment ].config[key] ?
-					config.env[ environment ].config[key] : 
-					data.defaultValue;
-					
-				// is a valid Divi Option.
-				if( 'et_divi' === group ){
-					diviOptions[data.name] = option_value;
-				// is a valid Divi Builder Option.
-				}else if( 'et_bfb_settings' === group ){
-					diviBuilderOptions[data.name] = option_value;
-				// is a valid Divi Update Option.
-				}else if( 'et_automatic_updates_options' === group ){
-					diviUpdateOptions[data.name] = option_value;
-				}
-
-			})
-		})
-
-		// parse option object back to string.
-		diviOptions = JSON.stringify( diviOptions );
-		diviBuilderOptions = JSON.stringify( diviBuilderOptions );
-		diviUpdateOptions = JSON.stringify( diviUpdateOptions );
-
-		// update each option.
-		cmds.push(`wp option update et_divi '${diviOptions}' --format=json`);
-		cmds.push(`wp option update et_bfb_settings '${diviBuilderOptions}' --format=json`);
-		cmds.push(`wp option update et_automatic_updates_options '${diviUpdateOptions}' --format=json`);
-			
-
-		if ( config.debug ) {
-			spinner.info(
-				`Running the following setup commands on the ${ environment } instance:\n - ${ setupCommands.join(
-					'\n - '
-				) }\n`
-			);
-		}
-		
-		// Execute theme option commands.
-		await runCLICmds(
-			environment,
-			cmds,
-			config,
-			spinner
-		)
-	}
-		
-	
-}
-
-export {
-	configureDivi,
-	isDiviThemeActive
-};

package/lib/wordpress/download-sources.js

@@ -1,286 +0,0 @@
-/**
- * Modified from wp-env 
- * Few modifications made:
- * - Downloads CAWebPublishing Resources, excluding WordPress.
- * - Ensure  parent directory of source.path exists before attempting to extract in downloadZipSource, otherwise it will complain that file/directory doesn't exist.
- * @see @wordpress/env/lib/download-sources.js
- */
-
-/**
- * External dependencies
- */
-import util from 'util';
-import path from 'path';
-import fs from 'fs-extra';
-import SimpleGit from 'simple-git';
-import got from 'got';
-import stream from 'stream';
-import zip from 'extract-zip';
-import { rimraf } from 'rimraf';
-import { env } from 'process';
-
-/**
- * Internal dependencies
- */
-
-/**
- * Promisified dependencies
- */
-const pipeline = util.promisify( stream.pipeline );
-const extractZip = util.promisify( zip );
-
-/**
- * Downloads the given source if necessary. The specific action taken depends
- * on the source type. The source is downloaded to source.path.
- *
- * @param {WPSource} source             The source to download.
- * @param {Object}   options
- * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
- * @param {Object}   options.spinner    A CLI spinner which indicates progress.
- * @param {boolean}  options.debug      True if debug mode is enabled.
- */
-async function downloadSource(src, { onProgress, spinner, debug } ){
-    if( 'git' == src.type ){
-        await downloadGitSource(src, { onProgress, spinner, debug });
-    }else if( 'zip' == src.type ) {
-        await downloadZipSource(src, { onProgress, spinner, debug });
-    }
-}
-
-/**
- * Clones the git repository at `source.url` into `source.path`. If the
- * repository already exists, it is updated instead.
- *
- * @param {WPSource} source             The source to download.
- * @param {Object}   options
- * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
- * @param {Object}   options.spinner    A CLI spinner which indicates progress.
- * @param {boolean}  options.debug      True if debug mode is enabled.
- */
-async function downloadGitSource( source, { onProgress, spinner, debug } ) {
-	const log = debug
-		? ( message ) => {
-				spinner.info( `SimpleGit: ${ message }` );
-				spinner.start();
-		  }
-		: () => {};
-	onProgress( 0 );
-
-	const progressHandler = ( { progress } ) => {
-		onProgress( progress / 100 );
-	};
-
-	log( 'Cloning or getting the repo.' );
-	const git = SimpleGit( { progress: progressHandler } );
-
-	const isRepo =
-		fs.existsSync( source.clonePath ) &&
-		( await git.cwd( source.clonePath ).checkIsRepo( 'root' ) );
-
-	// repository already exists.
-	if ( isRepo ) {
-		log( 'Repo already exists, using it.' );
-	} else {
-		// repository doesn't exists, but the directory does.
-		if( fs.existsSync( source.clonePath ) ){
-			// reinitialize repo.
-			await git.cwd( source.clonePath );
-
-			await git.init().addRemote('origin', source.url );
-		}else{
-
-			await git.clone( source.url, source.clonePath, {
-				'--depth': '1',
-				'--no-single-branch': null
-			} );
-			await git.cwd( source.clonePath );
-		}
-	}
-
-	log( 'Fetching the specified ref.' );
-	await git.fetch( 'origin', source.ref, {
-		'--tags': null,
-	} );
-
-	log( 'Checking out the specified ref.' );
-	await git.checkout( source.ref, {
-		'--force': null
-	});
-
-	onProgress( 1 );
-}
-
-/**
- * Downloads and extracts the zip file at `source.url` into `source.path`.
- *
- * @param {WPSource} source             The source to download.
- * @param {Object}   options
- * @param {Function} options.onProgress A function called with download progress. Will be invoked with one argument: a number that ranges from 0 to 1 which indicates current download progress for this source.
- * @param {Object}   options.spinner    A CLI spinner which indicates progress.
- * @param {boolean}  options.debug      True if debug mode is enabled.
- */
-async function downloadZipSource( source, { onProgress, spinner, debug } ) {
-	const log = debug
-		? ( message ) => {
-				spinner.info( `NodeGit: ${ message }` );
-				spinner.start();
-		  }
-		: () => {};
-	onProgress( 0 );
-
-	log( 'Downloading zip file.' );
-	const zipName = `${ source.path }.zip`;
-	const zipFile = fs.createWriteStream( zipName );
-	const responseStream = got.stream( source.url );
-	responseStream.on( 'downloadProgress', ( { percent } ) =>
-		onProgress( percent )
-	);
-
-	await pipeline( responseStream, zipFile );
-
-	log( 'Extracting to temporary directory.' );
-    // Target directory is expected to be absolute.
-	const tempDir = `${ source.path }.temp`;
-	await extractZip( zipName, { dir: tempDir } );
-
-	const files = (
-		await Promise.all( [
-			rimraf( zipName ),
-			rimraf( source.path ),
-			fs.promises.readdir( tempDir ),
-		] )
-	)[ 2 ];
-	/**
-	 * The plugin container is the extracted directory which is the direct parent
-	 * of the contents of the plugin. It seems a zip file can have two fairly
-	 * common approaches to where the content lives:
-	 * 1. The .zip is the direct container of the files. So after extraction, the
-	 *    extraction directory contains plugin contents.
-	 * 2. The .zip contains a directory with the same name which is the container.
-	 *    So after extraction, the extraction directory contains another directory.
-	 *    That subdirectory is the actual container of the plugin contents.
-	 *
-	 * We support both situations with the following check.
-	 */
-	let pluginContainer = tempDir;
-	const firstSubItem = path.join( tempDir, files[ 0 ] );
-	if (
-		files.length === 1 &&
-		( await fs.promises.lstat( firstSubItem ) ).isDirectory()
-	) {
-		// In this case, only one sub directory exists, so use that as the container.
-		pluginContainer = firstSubItem;
-	}
-	await fs.promises.rename( pluginContainer, source.path );
-	await rimraf( tempDir );
-
-	onProgress( 1 );
-}
-
-function defaultSources(pluginDir, themeDir){
-	return [
-		{
-			basename: 'CAWeb Theme',
-			url: 'https://github.com/CAWebPublishing/CAWeb/archive/refs/tags/1.13.3.zip',
-			path: path.join(themeDir, 'CAWeb'),
-			type: 'zip',
-
-		},
-		{
-			basename: 'CAWebPublishing Development Plugin',
-			url: 'https://github.com/CAWebPublishing/caweb-dev/archive/refs/tags/1.1.1.zip',
-			path: path.join(pluginDir, 'caweb-dev'),
-			type: 'zip',
-
-		},
-		{
-			basename: 'Query Monitor',
-			url: 'https://downloads.wordpress.org/plugin/query-monitor.3.17.2.zip',
-			path: path.join(pluginDir, 'query-monitor'),
-			type: 'zip',
-
-		}
-	]
-}
-
-/**
- * Download CAWeb Resources.
- * 
- * @param {WPEnvironment} environment The environment to configure. Either 'development' or 'tests'.
- * @param {Object}   spinner The spinner object to show progress.
- * @return {WPConfig} The config object we've loaded.
- */
-export async function downloadSources( environment,
-	{ 
-		spinner,
-		config
-	}  
-	) {
-	const progresses = {};
-	const getProgressSetter = ( id ) => ( progress ) => {
-		progresses[ id ] = progress;
-		spinner.text =
-			`Downloading ${id}.\n` +
-			Object.entries( progresses )
-				.map(
-					( [ key, value ] ) =>
-						`  - ${ key }: ${ ( value * 100 ).toFixed( 0 ) }/100%`
-				)
-				.join( '\n' );
-	};
-
-	const { workDirectoryPath } = config;
-	const { development: dev, tests: test } = config.env;
-
-	let instance = ('tests' === environment ? 'Tests-' : '') + 'WordPress';
-
-	let pluginDir = path.resolve(workDirectoryPath, instance , 'wp-content' , 'plugins');
-	let themeDir = path.resolve(workDirectoryPath, instance, 'wp-content' , 'themes');
-
-	let sources = defaultSources(pluginDir, themeDir);
-
-	// Add Divi Theme and plugin to sources.
-	if( (undefined !== dev.config.ET_USERNAME && 
-		undefined !== dev.config.ET_API_KEY) || 
-		(undefined !== test.config.ET_USERNAME && 
-		undefined !== test.config.ET_API_KEY)
-	){
-		let url = 'https://www.elegantthemes.com/api/api_downloads.php';
-		let user = undefined !== dev.config.ET_USERNAME ? dev.config.ET_USERNAME : test.config.ET_USERNAME;
-		let key = undefined !== dev.config.ET_API_KEY ? dev.config.ET_API_KEY : test.config.ET_API_KEY;
-		
-		// Add Divi sources.
-		sources = sources.concat( [
-			{
-				basename: 'Divi',
-				url: `${url}?api_update=1&theme=Divi&api_key=${key}&username=${user}`,
-				path: path.join(themeDir, 'Divi'),
-				type: 'zip'
-			},
-			{
-				basename: 'Divi Plugin',
-				url: `${url}?api_update=1&theme=divi-builder&api_key=${key}&username=${user}`,
-				path: path.join(pluginDir, 'divi-builder'),
-				type: 'zip'
-			}
-		]);
-	}
-
-	// Ensure plugin/theme directory exists for downloading resources.
-	// fs.ensureDir(themeDir);
-	// fs.ensureDir(pluginDir);
-
-	await Promise.all(
-		sources.map( ( source ) => {
-			if( 'development' === environment ){
-				downloadSource( source, {
-					onProgress: getProgressSetter( source.basename ),
-					spinner,
-				} )
-			}else{
-				downloadSource( source, {onProgress: () => {}, spinner} )
-			}
-		})
-	);
-	
-};