wp-advads 1.0.31 → 1.0.34

package/src/commands/release/change-version.js

@@ -4,19 +4,18 @@
 import fs from 'fs'
 import path from 'path'
 import logSymbols from 'log-symbols'
-import { forEach, waterfall } from 'async'
-
-/**
- * Internal Dependencies
- */
 import { pluginData } from '../release.js'
-import { getSetting, heading, onSameLine, saveConfig, updateFileContent, write } from "../../utilities/index.js"
+import { getSetting, heading, onSameLine, runSteps, saveConfig, updateFileContent, write } from "../../utilities/index.js"
 
 /**
  * Update version in readme.txt file
  *
  * @example Stable tag: {version}
  */
+export function applyStableTag( content, version ) {
+	return content.replace( /^(Stable tag:)[ \t]*.*$/mi, `$1 ${version}` )
+}
+
 function updateReadme(next) {
     updateFileContent(
         './readme.txt',
@@ -27,16 +26,12 @@ function updateReadme(next) {
         },
         next,
         (content) => {
-            let regex = new RegExp('^(?<prefix>Stable tag:\\h*)(?<version>(.*))$', 'mi')
-            regex = regex.exec(content)
-
-            if (null !== regex) {
-                regex = regex.groups
-                content = content.replace(`${regex.prefix}${regex.version}`, `${regex.prefix} ${pluginData.semver.getNextVersionString()}`)
+            const updated = applyStableTag( content, pluginData.semver.getNextVersionString() )
+            if ( updated !== content ) {
                 pluginData.commitMessages.push('update version in readme.txt')
             }
 
-            return content
+            return updated
         }
     )
 }
@@ -65,7 +60,7 @@ function updatePluginFiles(next) {
             return next(true)
         }
 
-        forEach(phpFiles, (fileName, nextFile) => {
+        const steps = phpFiles.map( ( fileName ) => ( nextFile ) => {
             updateFileContent(
                 fileName,
                 {
@@ -104,7 +99,9 @@ function updatePluginFiles(next) {
                     return content
                 }
             )
-        }, () => next())
+        } )
+
+        runSteps( steps, () => next() )
     })
 }
 
@@ -134,8 +131,8 @@ export default function updateVersionNumber(next) {
 
     flow.push(updatePluginFiles)
 
-    waterfall(
+    runSteps(
         flow,
-        () => next()
+        ( err ) => next( err )
     )
 }

package/src/commands/release/changelog.js

@@ -2,15 +2,9 @@
  * External Dependencies
  */
 import fs from 'fs'
-import path from 'path'
 import logSymbols from 'log-symbols'
-import { forEach, waterfall } from 'async'
-
-/**
- * Internal Dependencies
- */
 import { pluginData } from '../release.js';
-import { heading, execCommand, onSameLine, updateFileContent, write } from "../../utilities/index.js"
+import { heading, execCommand, getSetting, onSameLine, runSteps, updateFileContent, write } from "../../utilities/index.js"
 
 const LOCALES_CHANGELOG = {
     updated: {
@@ -92,11 +86,11 @@ function writeLocalesChangelog(type, changes) {
  * Update changelog for locales
  */
 function updateLocalesChangelog(next) {
-    const { glotpress = {} } = pluginData
+    const destination = getSetting('glotpress.destination') || './languages/'
 
     write('Generating translations changelog...')
 
-    execCommand('git ls-files ' + glotpress.destination, function(result) {
+    execCommand( [ 'git', 'ls-files', '--', destination ], function(result) {
         const files = result.split('\n').slice(0,-1)
         const changes = loopLocales(pluginData.locales, files)
 
@@ -133,7 +127,7 @@ function generateEntries(next) {
             return next(true)
         }
 
-        forEach(files.sort(), (fileName, nextFile) => {
+        for ( const fileName of files.sort() ) {
             const parts = fileName.split('-')
 
             if (allowed.includes(parts[0])) {
@@ -143,27 +137,25 @@ function generateEntries(next) {
                     `- ${labels[parts[0]]}: ${content.toString().trim()}`
                 )
             }
+        }
 
-            nextFile()
-        }, () => {
-            const currentDate = new Date();
-            const options = { year: 'numeric', month: 'long', day: 'numeric' };
-            pluginData.changelogChanges = [
-                ...changes['feature'],
-                ...changes['improvement'],
-                ...changes['fix'],
-            ]
-
-            pluginData.changelogChanges = pluginData.changelogChanges.length > 0
-                ? [
-                    `= ${pluginData.semver.getNextVersionString()} (${currentDate.toLocaleDateString('en', options)}) =`,
-                    '',
-                    ...pluginData.changelogChanges
-                ] : false
-
-            onSameLine(`${logSymbols.success} Changelog entries generated successfully`)
-            next()
-        })
+        const currentDate = new Date();
+        const options = { year: 'numeric', month: 'long', day: 'numeric' };
+        pluginData.changelogChanges = [
+            ...changes['feature'],
+            ...changes['improvement'],
+            ...changes['fix'],
+        ]
+
+        pluginData.changelogChanges = pluginData.changelogChanges.length > 0
+            ? [
+                `= ${pluginData.semver.getNextVersionString()} (${currentDate.toLocaleDateString('en', options)}) =`,
+                '',
+                ...pluginData.changelogChanges
+            ] : false
+
+        onSameLine(`${logSymbols.success} Changelog entries generated successfully`)
+        next()
     })
 }
 
@@ -257,5 +249,5 @@ export default function updateChangelog(next) {
         flow.push(cleanChangelogDirectory)
     }
 
-    waterfall( flow, () => next() )
+    runSteps( flow, ( err ) => next( err ) )
 }

package/src/commands/release/git.js

@@ -14,20 +14,32 @@ import { execCommand, onSameLine, getSetting, write } from "../../utilities/inde
  */
 export function getLatestTag() {
     return new Promise((resolve, reject) => {
-        try {
-            execCommand('git rev-list --tags --max-count=1', function(tags) {
-                execCommand( 'git describe --tags ' + tags.trim(), function(version) {
-                    version = version.trim()
-                    resolve( '' !== version ? version : getSetting( 'wp.version', '0.0.0' ) )
-                } )
-            })
-        }
-        catch (err) {
-            reject(err)
-        }
+        execCommand( 'git describe --tags --abbrev=0', function(version, error, stderr) {
+            if ( error ) {
+                const text = String( stderr || error.message || '' )
+                if ( /No names found/i.test( text ) ) {
+                    resolve( getSetting( 'wp.version', '0.0.0' ) )
+                    return
+                }
+
+                reject( error )
+                return
+            }
+
+            version = String( version || '' ).trim().replace(/^v/, '')
+            resolve( '' !== version ? version : getSetting( 'wp.version', '0.0.0' ) )
+        } )
     })
 }
 
+function gitRemoteFailed( error, stderr ) {
+    if ( error ) {
+        return true
+    }
+
+    return typeof stderr === 'string' && ( stderr.includes( 'error:' ) || stderr.includes( 'fatal:' ) )
+}
+
 /**
  * Check if user has permission to write to repo
  */
@@ -37,7 +49,7 @@ export function hasPermission(next) {
     write(`${message}....`)
 
     execCommand('git push --dry-run', function(result, error, stderr) {
-        if (stderr.includes('error:') || stderr.includes('fatal:')) {
+        if ( gitRemoteFailed( error, stderr ) ) {
             onSameLine(`${logSymbols.error} ${message}`)
             return next(true)
         }
@@ -56,7 +68,7 @@ export function gitFetch(next) {
     write(`${message}....`)
 
     execCommand('git fetch', function(result, error, stderr) {
-        if (stderr.includes('error:') || stderr.includes('fatal:')) {
+        if ( gitRemoteFailed( error, stderr ) ) {
             onSameLine(`${logSymbols.error} ${message}`)
             return next(true)
         }

package/src/commands/release/github.js

@@ -1,14 +1,14 @@
 /**
  * External Dependencies
  */
-import { waterfall } from 'async'
+import fs from 'fs'
 import logSymbols from 'log-symbols'
 
 /**
  * Internal Dependencies
  */
 import { pluginData } from '../release.js'
-import { execCommand, heading, onSameLine, write } from "../../utilities/index.js"
+import { execCommand, heading, onSameLine, runSteps, write } from "../../utilities/index.js"
 import {
     hasPermission,
     gitFetch,
@@ -22,14 +22,14 @@ import {
 export function githubPreTasks(next) {
     heading('Github operations')
 
-    waterfall(
+    runSteps(
         [
             hasPermission,
             gitFetch,
             verifyNextVersion,
             getCurrentBranchName,
         ],
-        ( err, results ) => {
+        ( err ) => {
             if(err) {
                 return next(true)
             }
@@ -48,13 +48,64 @@ export function githubFinalTasks(next) {
 
     const version = pluginData.semver.getNextVersionString()
     const message = pluginData.commitMessages.join('\n')
+    const files = releasePaths()
 
-    execCommand('git add .', function() {
-        execCommand(`git commit --no-verify -m 'bump version to ${version}' -m '${message}'`, function(result, err, stderr) {
-            execCommand('git push', function() {
-                onSameLine(`${logSymbols.success} Git commit successful`)
-                next()
-            })
-        })
-    })
+    if ( files.length < 1 ) {
+        onSameLine(`${logSymbols.error} No release files to commit`)
+        return next( new Error( 'No release files to commit' ) )
+    }
+
+    runSteps(
+        [
+            ( done ) => git( [ 'add', '--', ...files ], done ),
+            ( done ) => git(
+                [
+                    'commit',
+                    '-m',
+                    `bump version to ${version}`,
+                    '-m',
+                    message,
+                ],
+                done
+            ),
+            ( done ) => git( [ 'push' ], done ),
+        ],
+        ( error ) => {
+            if ( error ) {
+                return next( error )
+            }
+
+            onSameLine(`${logSymbols.success} Git commit successful`)
+            next()
+        }
+    )
+}
+
+function releasePaths() {
+    let phpFiles = []
+    try {
+        phpFiles = fs.readdirSync( '.' ).filter( ( file ) => {
+            return file.toLowerCase().endsWith( '.php' ) && file.toLowerCase() !== 'index.php'
+        } )
+    } catch ( _ ) {}
+
+    return [
+        'readme.txt',
+        'changelog.txt',
+        'wp.advads',
+        'languages',
+        '.changelog',
+        ...phpFiles,
+    ].filter( ( file ) => fs.existsSync( file ) )
+}
+
+function git( args, done ) {
+    execCommand( [ 'git', ...args ], ( stdout, error, stderr ) => {
+        if ( error ) {
+            onSameLine(`${logSymbols.error} ${stderr || error.message}`)
+            return done( error )
+        }
+
+        done()
+    } )
 }

package/src/commands/release/semver.js

@@ -17,7 +17,7 @@ const PRE_RELEASE_NAMES = [ 'alpha', 'beta', 'rc' ]
 /**
  * Semantic version generator
  */
-class SemVer {
+export class SemVer {
     constructor(baseVersion, increment, preRelease) {
         this.baseVersion = baseVersion
         this.increment = increment
@@ -40,14 +40,21 @@ class SemVer {
     }
 
     parseVersion() {
-        const regex = new RegExp('(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?:-(?<pre>alpha|beta|rc))?(?:\\.(?<pre_count>\\d+))?', 'gm')
-        this.baseVersion = { ...regex.exec(this.baseVersion).groups }
+        const regex = new RegExp('(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?:-(?<pre>alpha|beta|rc))?(?:\\.(?<pre_count>\\d+))?', 'm')
+        const match = regex.exec(this.baseVersion)
+
+        if ( ! match || ! match.groups ) {
+            console.log(`${logSymbols.error} ${chalk.bold.red(`Failed!`)} Invalid version: ${this.baseVersion}`)
+            throw new Error('failed')
+        }
+
+        this.baseVersion = { ...match.groups }
 
         this.baseVersion.major = parseInt(this.baseVersion.major)
         this.baseVersion.minor = parseInt(this.baseVersion.minor)
         this.baseVersion.patch = parseInt(this.baseVersion.patch)
         this.baseVersion.pre = undefined === this.baseVersion.pre ? false : this.baseVersion.pre
-        this.baseVersion.pre_count = undefined === this.baseVersion.pre_count ? false : this.baseVersion.pre_count
+        this.baseVersion.pre_count = undefined === this.baseVersion.pre_count ? false : parseInt(this.baseVersion.pre_count)
     }
 
     getNextVersion() {
@@ -68,17 +75,6 @@ class SemVer {
         return this.versionString;
     }
 
-    getLatestMinor() {
-        if (this.nextVersion.patch === 0) {
-            return this.getNextVersionString();
-        }
-
-        const latestMinor = {...this.nextVersion}
-        latestMinor.patch = 0
-
-        return `${this.nextVersion.major}.${this.nextVersion.minor}.${this.nextVersion.patch}`
-    }
-
     setupNextVersion() {
         this.nextVersion = { ...this.baseVersion }
 
@@ -116,6 +112,13 @@ class SemVer {
     }
 
     createPreReleaseFromPreRelease() {
+        if (this.baseVersion.pre === this.preRelease) {
+            this.nextVersion.pre_count = this.baseVersion.pre_count
+                ? this.baseVersion.pre_count + 1
+                : 1
+            return
+        }
+
         let increment = 'patch'
         if (this.baseVersion.patch === 0) {
             increment = this.baseVersion.minor ? 'major' : 'minor'
@@ -125,14 +128,8 @@ class SemVer {
             this.incrementVersion()
         }
 
-        if (this.baseVersion.pre === this.preRelease) {
-            this.nextVersion.pre_count = this.baseVersion.pre_count
-                ? 2
-                : this.baseVersion.pre_count + 1
-        } else {
-            this.nextVersion.pre       = this.preRelease
-            this.nextVersion.pre_count = 1
-        }
+        this.nextVersion.pre       = this.preRelease
+        this.nextVersion.pre_count = 1
 
         this.checkPreReleaseLogic()
     }
@@ -161,7 +158,7 @@ class SemVer {
      */
     checkPreReleaseLogic() {
         if (
-            isset(this.baseVersion.pre)
+            this.baseVersion.pre
             && (
                 this.nextVersion[this.increment] !== this.baseVersion[this.increment]
                 || this.nextVersion[this.increment] === 0
@@ -194,5 +191,5 @@ export default function getSemVer(next) {
         catch (err) {
             return next(true)
         }
-    })
+    }).catch( () => next(true) )
 }

package/src/commands/release/translations.js

@@ -7,38 +7,32 @@ import logSymbols from 'log-symbols'
  * Internal Dependencies
  */
 import { pluginData } from '../release.js'
-import { heading, execCommand, getSetting } from "../../utilities/index.js"
+import { heading } from "../../utilities/index.js"
+import { downloadTranslations } from '../wp-glotpress.js'
 
 /**
  * Execute routine to download translations from GlotPress
  */
-export default function updateTranslations( next ) {
+export default async function updateTranslations( next ) {
     heading('Downloading translations from glotpress')
 
-    const glotpress = getSetting('wp.glotpress')
+    try {
+        const { files, locales } = await downloadTranslations()
+        console.log( logSymbols.success + ` Downloaded ${files.length} files successfully` )
 
-    if (!glotpress) {
-        console.log( logSymbols.warning + ' No glotpress project found' )
-        next()
-        return;
-    }
-
-    execCommand( 'npx wp-advads translations', function(locales) {
-        locales = locales.split('\n').slice(4).slice(0,-1)
-        console.log( logSymbols.success + ` Downloaded ${locales.length} files successfully` )
-
-        if (locales.length > 0) {
+        if (files.length > 0) {
             pluginData.commitMessages.push('add: Download translation from GlotPress')
         }
 
-        const newLocales = {}
-        locales.map((locale) => {
-            const data = locale.split('=')
-            newLocales[ data[0] ] = data[1]
-        })
-
-        pluginData.locales = newLocales
-
+        pluginData.locales = locales
         next()
-    })
+    } catch (err) {
+        if ( err && err.message === 'No glotpress project found' ) {
+            console.log( logSymbols.warning + ' No glotpress project found' )
+            next()
+            return
+        }
+
+        next(err)
+    }
 }

package/src/commands/release.js

@@ -2,13 +2,12 @@
  * External Dependencies
  */
 import chalk from 'chalk'
-import { waterfall } from 'async'
 import logSymbols from 'log-symbols'
 
 /**
  * Node dependencies
  */
-import { heading } from '../utilities/index.js'
+import { heading, runSteps } from '../utilities/index.js'
 
 /**
  * Internal Dependencies
@@ -31,13 +30,13 @@ export default async () => {
     heading('Releasing the plugin...')
     console.log('------------------------------------------------');
 
-    waterfall(
+    runSteps(
         [
             prompts,
             getSemVer,
             githubPreTasks,
             updateTranslations,
-            wpBuild,
+            ( next ) => wpBuild( next, pluginData.commitMessages ),
             updateVersionNumber,
             updateChangelog,
             githubFinalTasks

package/src/commands/updates.js

@@ -2,30 +2,33 @@
  * Node Dependencies
  */
 import path from 'path';
-import fs from 'fs-extra';
 
 /**
  * Internal Dependencies
  */
-import { getSetting, writeFile, heading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+import { getSetting, heading, getProjectRoot, writeFromTemplate } from "../utilities/index.js";
 
-export default (version) => {
+export default (version, options = {}) => {
 	heading('Creating update file...')
 
-	try {
-		const filename = `upgrade-${version}.php`;
-		const folder = path.join(getProjectRoot(), getSetting('paths.updates'));
-
-		// Data
-		const data = getSetting();
-		data.heading = `Update routine for version ${version}`;
-		data.version = version.replaceAll('.', '_');
-
-		const content = compileTemplate(getTemplateFile('files/update.php'), data);
-		writeFile(folder,filename, content)
+	const settings = getSetting()
+	const data = {
+		...settings,
+		heading: `Update routine for version ${version}`,
+		description: `Update routine for version ${version}`,
+		prefix: settings.misc?.prefix,
+		version: version.replaceAll('.', '_'),
 	}
-	catch (err) {
-		msgErrorTitle('We failed!!!');
-		throw err;
+
+	if ( ! data.prefix ) {
+		throw new Error( 'misc.prefix is required' );
 	}
+
+	writeFromTemplate(
+		path.join(getProjectRoot(), getSetting('paths.updates')),
+		`upgrade-${version}.php`,
+		'files/update.php',
+		data,
+		options.force
+	)
 }

package/src/commands/views.js

@@ -1,4 +1,3 @@
-
 /**
  * Node Dependencies
  */
@@ -7,25 +6,24 @@ import path from 'path';
 /**
  * Internal Dependencies
  */
-import { getSetting, writeFile, heading, filenameToHeading, getProjectRoot, msgErrorTitle, getTemplateFile, compileTemplate } from "../utilities/index.js";
+import { getSetting, heading, filenameToHeading, getProjectRoot, writeFromTemplate } from "../utilities/index.js";
 
-export default (name, header) => {
+export default (name, header, options = {}) => {
 	heading('Creating view file...')
 
-	try {
-		const paths = name.toLowerCase().split('/')
-		const filename = paths.pop() + '.php';
-		const folder = path.join(getProjectRoot(), getSetting('paths.views'), paths.join('/'));
-
-		// Data
-		const data = getSetting();
-		data.heading = header || filenameToHeading(filename) + ' template file';
+	const dest = path.join( getProjectRoot(), getSetting( 'paths.views' ), name.toLowerCase().replaceAll( '\\', '/' ) ) + '.php'
+	const filename = path.basename( dest )
+	const headingText = header || filenameToHeading(filename) + ' template file'
 
-		const content = compileTemplate(getTemplateFile('files/view.php'), data);
-		writeFile(folder, filename, content);
-	}
-	catch (err) {
-		msgErrorTitle('We failed!!!');
-		throw err;
-	}
+	writeFromTemplate(
+		path.dirname( dest ),
+		filename,
+		'files/view.php',
+		{
+			...getSetting(),
+			heading: headingText,
+			description: headingText,
+		},
+		options.force
+	)
 }