Merge pull request #73 from kadamwhite/remove-underscore-dependency

kadamwhite · web-flow · commit fd7cc521e486 · 2019-03-18T20:19:09.000-04:00
Remove Underscore
diff --git a/.eslintrc b/.eslintrc
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,12 @@
+module.exports = {
+	root: true,
+	env: {
+		es6: true,
+		node: true
+	},
+	extends: 'plugin:@wordpress/eslint-plugin/recommended',
+	rules: {
+		'one-var': [ 'error', 'never' ],
+		'prefer-arrow-callback': [ 'error' ]
+	}
+};
diff --git a/lib/patch.js b/lib/patch.js
@@ -1,18 +1,17 @@
-const _ = require( 'underscore' );
-
-_.str = _.str = require( 'underscore.string' );
-_.mixin( _.str.exports() );
+// Ensure both arguments are strings and that str begins with starts.
+function startsWith( str, starts ) {
+	return 0 === ( '' + str ).lastIndexOf( '' + starts, 0 );
+}
 
 module.exports = {
 	isAb( diff ) {
 		let ab = false;
 		try {
-			diff = diff.split( '\n' );
-			_.each( diff, ( line ) => {
-				if ( _.startsWith( line, 'diff --git a/' ) ) {
+			diff.split( '\n' ).forEach( ( line ) => {
+				if ( startsWith( line, 'diff --git a/' ) ) {
 					throw true;
 				}
-				if ( _.startsWith( line, 'Index: trunk/wp-' ) ) {
+				if ( startsWith( line, 'Index: trunk/wp-' ) ) {
 					throw true;
 				}
 			} );
@@ -51,45 +50,44 @@ module.exports = {
 		];
 
 		try {
-			diff = diff.split( '\n' );
-			_.each( diff, ( line ) => {
+			diff.split( '\n' ).forEach( ( line ) => {
 				// these are often the first line
-				if ( _.startsWith( line, 'Index: src/' ) ||
-					_.startsWith( line, 'Index: tests/' ) ||
-					_.startsWith( line, 'Index: tools/' ) ||
-					_.startsWith( line, 'diff --git src' ) ||
-					_.startsWith( line, 'diff --git test' ) ||
-					_.startsWith( line, 'diff --git tools' ) ||
-					_.startsWith( line, 'diff --git a/src' ) ||
-					_.startsWith( line, 'diff --git a/test' ) ||
-					_.startsWith( line, 'diff --git a/tools' )
+				if ( startsWith( line, 'Index: src/' ) ||
+					startsWith( line, 'Index: tests/' ) ||
+					startsWith( line, 'Index: tools/' ) ||
+					startsWith( line, 'diff --git src' ) ||
+					startsWith( line, 'diff --git test' ) ||
+					startsWith( line, 'diff --git tools' ) ||
+					startsWith( line, 'diff --git a/src' ) ||
+					startsWith( line, 'diff --git a/test' ) ||
+					startsWith( line, 'diff --git a/tools' )
 
 				) {
 					throw false;
 				}
 
-				_.each( wpDashExceptions, ( exception ) => {
-					if ( _.startsWith( line, 'Index: ' + exception ) ||
-						_.startsWith( line, 'diff --git ' + exception ) ||
-						_.startsWith( line, 'diff --git a/' + exception )
+				wpDashExceptions.forEach( ( exception ) => {
+					if ( startsWith( line, 'Index: ' + exception ) ||
+						startsWith( line, 'diff --git ' + exception ) ||
+						startsWith( line, 'diff --git a/' + exception )
 					) {
 						throw false;
 					}
 				} );
 
-				_.each( noWpDashExceptions, ( exception ) => {
-					if ( _.startsWith( line, 'Index: ' + exception ) ||
-						_.startsWith( line, 'diff --git ' + exception ) ||
-						_.startsWith( line, 'diff --git a/' + exception )
+				noWpDashExceptions.forEach( ( exception ) => {
+					if ( startsWith( line, 'Index: ' + exception ) ||
+						startsWith( line, 'diff --git ' + exception ) ||
+						startsWith( line, 'diff --git a/' + exception )
 					) {
 						throw true;
 					}
 				} );
 
-				if ( _.startsWith( line, 'Index: wp-' ) ||
-					_.startsWith( line, 'Index: trunk/wp-' ) ||
-					_.startsWith( line, 'diff --git wp-' ) ||
-					_.startsWith( line, 'diff --git a/wp-' )
+				if ( startsWith( line, 'Index: wp-' ) ||
+					startsWith( line, 'Index: trunk/wp-' ) ||
+					startsWith( line, 'diff --git wp-' ) ||
+					startsWith( line, 'diff --git a/wp-' )
 				) {
 					throw true;
 				}
diff --git a/lib/regex.js b/lib/regex.js
@@ -1,26 +1,32 @@
-const _ = require( 'underscore' );
-
-_.str = _.str = require( 'underscore.string' );
-_.mixin( _.str.exports() );
-
 module.exports = {
 	patchAttachments( html ) {
 		return html.match( /<dt>\s*<a\s+href="([^"]+?)(diff|patch)"\s+title="View attachment">([^<]+)/g );
 	},
+
 	urlsFromAttachmentList( html ) {
 		return html.match( /href="([^"]+)"/ );
 	},
+
 	longMatches( html ) {
 		return html.match( /<dt([\s|\S]*?)dt>/g );
 	},
+
 	possiblePatches( longMatches ) {
-		return _.compact( _.map( longMatches, ( match ) => {
-			if ( match.match( /(patch|diff)"/ ) ) {
-				return _.clean( _.trim( _( match ).stripTags().replace( /\n/g, ' ' ) ) );
-			}
-			return false;
-		} ) );
+		return longMatches
+			.map( ( match ) => {
+				if ( match.match( /(patch|diff)"/ ) ) {
+					return match
+						// Remove any HTML tags.
+						.replace( /<\/?[^>]+>/g, '' )
+						// Collapse consecutive whitespace characters into one space.
+						.replace( /\s+/g, ' ' )
+						.trim();
+				}
+				return false;
+			} )
+			.filter( Boolean );
 	},
+
 	localFileClean( file ) {
 		return file.replace( '?', '' ).replace( /\s/g, '' );
 	},
diff --git a/package.json b/package.json
@@ -1,51 +1,52 @@
 {
-  "name": "grunt-patch-wordpress",
-  "description": "Patch your core WordPress",
-  "version": "1.0.0",
-  "homepage": "https://github.com/wordpress/grunt-patch-wordpress",
-  "author": {
-    "name": "Aaron Jorbin",
-    "email": "aaron@jorb.in",
-    "url": "http://aaron.jorb.in"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/wordpress/grunt-patch-wordpress.git"
-  },
-  "bugs": {
-    "url": "https://github.com/wordpress/grunt-patch-wordpress/issues"
-  },
-  "license": "MIT",
-  "main": "Gruntfile.js",
-  "engines": {
-    "node": ">= 8.9.3"
-  },
-  "scripts": {
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "jest --watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "jest": {
-    "testMatch": [
-      "**/test/**/*.js"
-    ]
-  },
-  "devDependencies": {
-    "@wordpress/eslint-plugin": "^2.0.0",
-    "eslint": "^5.15.1",
-    "jest": "^24.5.0"
-  },
-  "dependencies": {
-    "grunt": "^1.0.2",
-    "inquirer": "^5.1.0",
-    "request": "^2.83.0",
-    "underscore": "~1.9.0",
-    "underscore.string": "~3.3.4",
-    "xmlrpc": "^1.3.1"
-  },
-  "keywords": [
-    "gruntplugin"
-  ]
+	"name": "grunt-patch-wordpress",
+	"description": "Patch your core WordPress",
+	"version": "1.0.0",
+	"homepage": "https://github.com/wordpress/grunt-patch-wordpress",
+	"author": {
+		"name": "Aaron Jorbin",
+		"email": "aaron@jorb.in",
+		"url": "http://aaron.jorb.in"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git://github.com/wordpress/grunt-patch-wordpress.git"
+	},
+	"bugs": {
+		"url": "https://github.com/wordpress/grunt-patch-wordpress/issues"
+	},
+	"license": "MIT",
+	"main": "Gruntfile.js",
+	"engines": {
+		"node": ">= 8.9.3"
+	},
+	"scripts": {
+		"test": "jest",
+		"test:coverage": "jest --coverage",
+		"test:watch": "jest --watch",
+		"lint": "eslint .",
+		"lint:fix": "eslint . --fix"
+	},
+	"jest": {
+		"testMatch": [
+			"**/test/**/*.js"
+		],
+		"testPathIgnorePatterns": [
+			".eslintrc.js"
+		]
+	},
+	"devDependencies": {
+		"@wordpress/eslint-plugin": "^2.0.0",
+		"eslint": "^5.15.1",
+		"jest": "^24.5.0"
+	},
+	"dependencies": {
+		"grunt": "^1.0.2",
+		"inquirer": "^5.1.0",
+		"request": "^2.83.0",
+		"xmlrpc": "^1.3.1"
+	},
+	"keywords": [
+		"gruntplugin"
+	]
 }
diff --git a/tasks/patch_wordpress.js b/tasks/patch_wordpress.js
@@ -14,16 +14,12 @@ const spawn = require( 'child_process' ).spawn;
 const inquirer = require( 'inquirer' );
 const url = require( 'url' );
 const fs = require( 'fs' );
-const _ = require( 'underscore' );
 const trac = require( '../lib/trac.js' );
 const patch = require( '../lib/patch.js' );
 const regex = require( '../lib/regex.js' );
 const xmlrpc = require( 'xmlrpc' );
 const mapOldToNewFilePath = require( '../lib/map_old_to_new_file_path.js' );
 
-_.str = _.str = require( 'underscore.string' );
-_.mixin( _.str.exports() );
-
 module.exports = function( grunt ) {
 	let tempFile = 'wppatch.diff';
 	const defaults = {
@@ -171,7 +167,7 @@ module.exports = function( grunt ) {
 					] ).then( ( answers ) => {
 						grunt.log.debug( 'answers:' + JSON.stringify( answers ) );
 						matchUrl = options.tracUrl +
-						regex.urlsFromAttachmentList( matches[ _.indexOf( possiblePatches, answers.patch_name ) ] )[ 1 ];
+						regex.urlsFromAttachmentList( matches[ possiblePatches.indexOf( answers.patch_name ) ] )[ 1 ];
 						getPatch( trac.convertToRaw( url.parse( 'https://' + matchUrl ) ), options );
 					} );
 				}
@@ -233,9 +229,9 @@ module.exports = function( grunt ) {
 
 	function localFile( error, result, code, done, options ) {
 		if ( ! error ) {
-			const files = _.filter( result.split( '\n' ), ( file ) => {
-				return ( _.str.include( file, 'patch' ) || _.str.include( file, 'diff' ) );
-			} );
+			const files = result.split( '\n' ).filter( ( file ) => (
+				file.includes( 'patch' ) || file.includes( 'diff' )
+			) );
 			grunt.log.debug( 'files: ' + JSON.stringify( files ) );
 
 			if ( 0 === files.length ) {
diff --git a/test/.eslintrc b/test/.eslintrc
diff --git a/test/.eslintrc.js b/test/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+	env: {
+		jest: true,
+	},
+};
diff --git a/test/regex.js b/test/regex.js
@@ -12,7 +12,10 @@ describe( 'regular expressions', () => {
 
 		expect( matches.length ).toBe( 2 );
 		expect( longMatches.length ).toBe( 4 );
-		expect( possiblePatches.length ).toBe( 2 );
+		expect( possiblePatches ).toEqual( [
+			'edit-form-comment.diff​ (626 bytes) - added by Thaicloud 7 weeks ago.',
+			'23988-edit-comment.diff​ (1.1 KB) - added by seanchayes 13 days ago.',
+		] );
 	} );
 
 	it( 'one patch on a ticket', () => {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +module.exports = {
 +	env: {
 +		jest: true,
 +	},
 +};