Added comments for each step to the advanced examples

Author: WyriHaximus

examples/advanced-add-topic-php-to-all-repositories-that-start-their-name-with-php.php

@@ -12,19 +12,26 @@
 $loop = Factory::create();
 $client = AsyncClient::create($loop, require 'resolve_token.php');
 
-unwrapObservableFromPromise($client->user($argv[1])->then(function (UserInterface $user) use ($argv) {
+// Fetch the user/org given as first argument to this script
+unwrapObservableFromPromise($githubClient->user($argv[1])->then(function (UserInterface $user) use ($argv) {
     resource_pretty_print($user);
 
+    // Get all repositories for the given user
     return $user->repositories();
 }))->filter(function (Repository $repository) {
+    // Filter out forks
     return !$repository->fork();
 })->filter(function (Repository $repository) {
+    // Filter out repositories with nothing in them
     return $repository->size() > 0;
 })->filter(function (Repository $repository) {
+    // Filter out all repositories that start their name with php
     return substr($repository->name(), 0, 3) === 'php';
 })->filter(function (Repository $repository) {
+    // Be sure the repository doesn't have PHP in it's topics already
     return !in_array('php', $repository->topics(), true);
 })->subscribe(function (Repository $repository) {
+    // Add php to the list of topics and update (replace) the topics
     $topics = $repository->topics();
     $topics[] = 'php';
 

examples/advanced-enable-travis-for-non-forks-and-files-with-a-travis-yml.php

@@ -55,22 +55,32 @@
     ],
 ]);
 
+// Fetch the user/org given as first argument to this script
 unwrapObservableFromPromise($githubClient->user($argv[1])->then(function (UserInterface $user) use ($argv) {
     resource_pretty_print($user);
 
+    // Get all repositories for the given user
     return $user->repositories();
 }))->filter(function (Repository $repository) {
+    // Filter out forks
     return !$repository->fork();
 })->filter(function (Repository $repository) {
+    // Filter out repositories with nothing in them
     return $repository->size() > 0;
 })->filter(function (Repository $repository) {
+    // Only check repositories that start with reactphp-http
+    // This is optional and you can remove this to check all repositories
+    // BUT that takes a lot of calls to check and time due to throttling
     return strpos($repository->name(), 'reactphp-http') === 0;
 })->flatMap(function (Repository $repository) {
+    // Check if the repository contains a .travis.yml
     return Observable::fromPromise(new React\Promise\Promise(function ($resolve, $reject) use ($repository) {
         $hasTravisYml = false;
         $repository->contents()->filter(function ($node) {
+            // Only let through files
             return $node instanceof FileInterface;
         })->filter(function (File $file) {
+            // Only let the .travis.yml file through
             return $file->name() === '.travis.yml';
         })->subscribe(function () use (&$hasTravisYml) {
             $hasTravisYml = true;
@@ -84,19 +94,24 @@
     })
     ->mapTo($repository);
 })->flatMap(function (Repository $repository) {
+    // Get Travis repository for the Github repository
     return Observable::fromPromise($repository->travisRepository());
 })->flatMap(function (TravisRepository $repository) {
+    // Check if the repository on Travis is active
+    // We're only interested in inactive repositories
     return Observable::fromPromise($repository->isActive())
         ->filter(function ($isActive) {
             return !$isActive;
         })
         ->mapTo($repository);
 })->subscribe(function (TravisRepository $repository) {
+    // Activate repository on Travis
     $repository->enable()->done(function (TravisRepository $repository) {
         resource_pretty_print($repository);
     }, 'display_throwable');
 }, 'display_throwable');
 
 $loop->run();
 
+// Display Github API token status
 displayState($githubClient->getRateLimitState());