Merge pull request #31 from wp-cli/30-create-directory-if-not-exists

Add `--create-target-dir` flag

Author: swissspidy

README.md

@@ -5,12 +5,12 @@ Create a distribution .zip or .tar.gz based on a plugin or theme's .distignore f
 
 [![CircleCI](https://circleci.com/gh/wp-cli/dist-archive-command/tree/master.svg?style=svg)](https://circleci.com/gh/wp-cli/dist-archive-command/tree/master)
 
-Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
+Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)
 
 ## Using
 
 ~~~
-wp dist-archive <path> [<target>] [--format=<format>]
+wp dist-archive <path> [<target>] [--create-target-dir] [--format=<format>]
 ~~~
 
 For a plugin in a directory 'wp-content/plugins/hello-world', this command
@@ -39,6 +39,9 @@ script in each project.
 	[<target>]
 		Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
 
+	[--create-target-dir]
+		Automatically create the target directory as needed.
+
 	[--format=<format>]
 		Choose the format for the archive.
 		---
@@ -50,7 +53,7 @@ script in each project.
 
 ## Installing
 
-Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with `wp cli update`.
+Installing this package requires WP-CLI v2 or greater. Update to the latest stable release with `wp cli update`.
 
 Once you've done so, you can install this package with:
 
@@ -62,30 +65,25 @@ We appreciate you taking the initiative to contribute to this project.
 
 Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
 
+For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.
+
 ### Reporting a bug
 
 Think you’ve found a bug? We’d love for you to help us get it fixed.
 
 Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/dist-archive-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
 
-Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/dist-archive-command/issues/new) with the following:
-
-1. What you were doing (e.g. "When I run `wp post list`").
-2. What you saw (e.g. "I see a fatal about a class being undefined.").
-3. What you expected to see (e.g. "I expected to see the list of posts.")
-
-Include as much detail as you can, and clear steps to reproduce if possible.
+Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/dist-archive-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).
 
 ### Creating a pull request
 
 Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/dist-archive-command/issues/new) to discuss whether the feature is a good fit for the project.
 
-Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
+Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.
+
+## Support
 
-1. Create a feature branch for each contribution.
-2. Submit your pull request early for feedback.
-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/).
+Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
 
 
 *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.*

composer.json

@@ -24,7 +24,12 @@
     "extra": {
         "commands": [
             "dist-archive"
-        ]
+        ],
+        "readme": {
+            "shields": [
+                "[![CircleCI](https://circleci.com/gh/wp-cli/dist-archive-command/tree/master.svg?style=svg)](https://circleci.com/gh/wp-cli/dist-archive-command/tree/master)"
+            ]
+        }
     },
     "autoload": {
         "psr-4": {

features/dist-archive.feature

@@ -148,3 +148,26 @@ Feature: Generate a distribution archive of a project
       | format  | extension | extract   |
       | zip     | zip       | unzip     |
       | targz   | tar.gz    | tar -zxvf |
+
+  Scenario: Create directories automatically if requested
+    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 try `wp dist-archive wp-content/plugins/hello-world {RUN_DIR}/some/nested/folder/hello-world.zip`
+    Then STDERR should contain:
+      """
+      Error: Target directory does not exist
+      """
+
+    When I run `wp dist-archive --create-target-dir wp-content/plugins/hello-world {RUN_DIR}/some/nested/folder/hello-world.zip`
+    Then STDOUT should be:
+      """
+      Success: Created hello-world.zip
+      """
+    And STDERR should be empty
+    And the {RUN_DIR}/some/nested/folder/hello-world.zip file should exist

src/Dist_Archive_Command.php

@@ -1,5 +1,7 @@
 <?php
 
+use WP_CLI\Utils;
+
 /**
  * Create a distribution archive based on a project's .distignore file.
  */
@@ -34,6 +36,9 @@ class Dist_Archive_Command {
 	 * [<target>]
 	 * : Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
 	 *
+	 * [--create-target-dir]
+	 * : Automatically create the target directory as needed.
+	 *
 	 * [--format=<format>]
 	 * : Choose the format for the archive.
 	 * ---
@@ -119,6 +124,14 @@ public function __invoke( $args, $assoc_args ) {
 
 		chdir( dirname( $path ) );
 
+		if ( Utils\get_flag_value( $assoc_args, 'create-target-dir' ) ) {
+			$this->maybe_create_directory( $archive_file );
+		}
+
+		if ( ! is_dir( dirname( $archive_file ) ) ) {
+			WP_CLI::error( "Target directory does not exist: {$archive_file}" );
+		}
+
 		if ( 'zip' === $assoc_args['format'] ) {
 			$excludes = implode( ' --exclude ', $ignored_files );
 			if ( ! empty( $excludes ) ) {
@@ -149,4 +162,16 @@ function( $ignored_file ) {
 		}
 	}
 
+	/**
+	 * Create the directory for a target file if it does not exist yet.
+	 *
+	 * @param string $archive_file Path and filename of the target file.
+	 * @return void
+	 */
+	private function maybe_create_directory( $archive_file ) {
+		$directory = dirname( $archive_file );
+		if ( ! is_dir( $directory ) ) {
+			mkdir( $directory, $mode = 0777, $recursive = true );
+		}
+	}
 }