Prepare examples for use as fixtures

Author: jigarius

Phpakefile

@@ -6,23 +6,10 @@
  */
 
 /**
- * Display hello world.
- */
-function hello_world() {
-  echo 'Hello world' . PHP_EOL;
-}
-
-/**
- * Function names starting with _ do not translate into commands.
- */
-function _this_is_not_a_task() {
-  // Do something.
-}
-
-/**
- * Additional Phpakefile can be imported like a regular PHP file.
+ * Phpakefiles can be imported like a regular PHP files.
  */
+require_once __DIR__ . '/examples/hello-world.phpakefile';
 require_once __DIR__ . '/examples/input-output.phpakefile';
 require_once __DIR__ . '/examples/variadic.phpakefile';
 require_once __DIR__ . '/examples/shell.phpakefile';
-require_once __DIR__ . '/examples/namespace.phpakefile';
+require_once __DIR__ . '/examples/fizzbuzz.phpakefile';

README.md

@@ -56,11 +56,12 @@ A *Phpakefile* contains definitions of tasks that can be executed by Phpake.
 The following subheadings are about defining such tasks. A Phpake task definition
 is simply a PHP function (a task callback). Here's are some examples:
 
-- [Hello world](Phpakefile)
+- [Hello world](examples/hello-world.phpakefile)
 - [Input Output](examples/input-output.phpakefile)
-- [Namespaces](examples/variadic.phpakefile)
+- [Namespaces](examples/fizzbuzz.phpakefile)
 - [Variadic arguments](examples/variadic.phpakefile)
 - [Shell commands](examples/shell.phpakefile)
+- [Including commands](Phpakefile)
 
 ## Simple tasks
 

examples/namespace.phpakefile renamed to examples/fizzbuzz.phpakefile

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Say hello world.
+ */
+function hello_world() {
+  echo 'Hello world' . PHP_EOL;
+}
+
+function hello_ladies() {
+  // Doc block comments are optional.
+  // This task will be recognized and it will work.
+}
+
+/**
+ * A task that fails and returns a non-zero error code.
+ */
+function make_a_mess() {
+  return 19;
+}
+
+/**
+ * Function names starting with _ do not translate into commands.
+ */
+function _this_is_not_a_task() {
+  // Do something.
+}

examples/hello-world.phpakefile

@@ -16,17 +16,17 @@ function show_date($output) {
 }
 
 /**
- * Says hello to a human.
+ * Say hello to a human.
  *
  * Uses a required parameter, and an optional parameter. "param" annotations
  * are used, to describe the parameters. These descriptions are displayed with
  * command-specific help.
  *
+ * Notice how the in-built parameter $output was kept towards the end.
+ *
  * @usage Niki
  * @usage Niki Martin
  *
- * Notice how the in-built parameter $output was kept towards the end.
- *
  * @param string $fname First name.
  * @param string|null $lname Last name.
  * @param object $output
@@ -35,10 +35,3 @@ function hello_human(string $fname, string $lname = NULL, $output = NULL) {
   $name = $lname ? "$fname $lname" : "$fname";
   $output->writeln("Hello <info>$name</info>!");
 }
-
-/**
- * A task that fails and returns a non-zero error code.
- */
-function make_a_mess() {
-  return 19;
-}