Merge pull request #10 from runcommand/1-targz

Archive to `.tar.gz` with `--format=targz`

Author: danielbachhuber

README.md

@@ -85,4 +85,5 @@ Once you've decided to commit the time to seeing your pull request through, plea
 3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
 4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
 
+
 *This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

command.php

@@ -96,25 +96,42 @@
 		}
 	}
 
-	if ( 'zip' === $assoc_args['format'] ) {
-		if ( is_null( $archive_file ) ) {
-			$archive_file = dirname( $path ) . '/' . $archive_base . $version . '.zip';
+	if ( is_null( $archive_file ) ) {
+		$archive_file = dirname( $path ) . '/' . $archive_base . $version;
+		if ( 'zip' === $assoc_args['format'] ) {
+			$archive_file .= '.zip';
+		} else if ( 'targz' === $assoc_args['format'] ) {
+			$archive_file .= '.tar.gz';
 		}
+	}
+
+	chdir( dirname( $path ) );
+
+	if ( 'zip' === $assoc_args['format'] ) {
 		$excludes = implode( ' --exclude ', $ignored_files );
 		if ( ! empty( $excludes ) ) {
 			$excludes = ' --exclude ' . $excludes;
 		}
-		chdir( dirname( $path ) );
 		$cmd = "zip -r {$archive_file} {$archive_base} {$excludes}";
-		WP_CLI::debug( "Running: {$cmd}", 'dist-archive' );
-		$ret = WP_CLI::launch( escapeshellcmd( $cmd ), false, true );
-		if ( 0 === $ret->return_code ) {
-			$filename = pathinfo( $archive_file, PATHINFO_BASENAME );
-			WP_CLI::success( "Created {$filename}" );
-		} else {
-			$error = $ret->stderr ? $ret->stderr : $ret->stdout;
-			WP_CLI::error( $error );
-		}
+	} else if ( 'targz' === $assoc_args['format'] ) {
+		$excludes = array_map( function( $ignored_file ){
+			if ( '/*' === substr( $ignored_file, -2 ) ) {
+				$ignored_file = substr( $ignored_file, 0, ( strlen( $ignored_file ) - 2 ) );
+			}
+			return "--exclude='{$ignored_file}'";
+		}, $ignored_files );
+		$excludes = implode( ' ', $excludes );
+		$cmd = "tar {$excludes} -zcvf {$archive_file} {$archive_base}";
+	}
+
+	WP_CLI::debug( "Running: {$cmd}", 'dist-archive' );
+	$ret = WP_CLI::launch( escapeshellcmd( $cmd ), false, true );
+	if ( 0 === $ret->return_code ) {
+		$filename = pathinfo( $archive_file, PATHINFO_BASENAME );
+		WP_CLI::success( "Created {$filename}" );
+	} else {
+		$error = $ret->stderr ? $ret->stderr : $ret->stdout;
+		WP_CLI::error( $error );
 	}
 
 };

features/dist-archive.feature

@@ -10,6 +10,11 @@ Feature: Generate a distribution archive of a project
     And the wp-content/plugins/hello-world/bin directory should exist
 
     When I run `wp dist-archive wp-content/plugins/hello-world`
+    Then STDOUT should be:
+      """
+      Success: Created hello-world.0.1.0.zip
+      """
+    And STDERR should be empty
     And the wp-content/plugins/hello-world.0.1.0.zip file should exist
 
     When I run `wp plugin delete hello-world`
@@ -21,6 +26,32 @@ Feature: Generate a distribution archive of a project
     And the wp-content/plugins/hello-world/.travis.yml file should not exist
     And the wp-content/plugins/hello-world/bin directory should not exist
 
+  Scenario: Generates a tarball archive with a flag
+    Given a WP install
+
+    When I run `wp scaffold plugin hello-world`
+    Then the wp-content/plugins/hello-world directory should exist
+    And the wp-content/plugins/hello-world/hello-world.php file should exist
+    And the wp-content/plugins/hello-world/.travis.yml file should exist
+    And the wp-content/plugins/hello-world/bin directory should exist
+
+    When I run `wp dist-archive wp-content/plugins/hello-world --format=targz`
+    Then STDOUT should be:
+      """
+      Success: Created hello-world.0.1.0.tar.gz
+      """
+    And STDERR should be empty
+    And the wp-content/plugins/hello-world.0.1.0.tar.gz file should exist
+
+    When I run `wp plugin delete hello-world`
+    Then the wp-content/plugins/hello-world directory should not exist
+
+    When I run `cd wp-content/plugins/ && tar -zxvf hello-world.0.1.0.tar.gz`
+    Then the wp-content/plugins/hello-world directory should exist
+    And the wp-content/plugins/hello-world/hello-world.php file should exist
+    And the wp-content/plugins/hello-world/.travis.yml file should not exist
+    And the wp-content/plugins/hello-world/bin directory should not exist
+
   Scenario: Generate a ZIP archive to a custom path
     Given a WP install