Invert include/exclude logic on DivinerAtomQuery

Summary: Fixes T8401. Change `withIncludeGhosts()` to `withExcludeGhosts()` and `withIncludeUndocumentable()` to `withExcludeDocumentable()`. In particular, this allows querying for atoms by PHID to work as expected.

Test Plan: I got confused with double negatives so I might have gotten some of these wrong... I poked around Diviner and re-generated documentation to verify that this is working as expected.

Reviewers: epriestley, #blessed_reviewers

Reviewed By: epriestley, #blessed_reviewers

Subscribers: Korvin, epriestley

Maniphest Tasks: T8401

Differential Revision: https://secure.phabricator.com/D13157

src/applications/diviner/controller/DivinerAtomController.php

@@ -47,6 +47,8 @@ final class DivinerAtomController extends DivinerController {
       ->withNames(array($this->atomName))
       ->withContexts(array($this->atomContext))
       ->withIndexes(array($this->atomIndex))
+      ->withGhosts(false)
+      ->withIsDocumentable(true)
       ->needAtoms(true)
       ->needExtends(true)
       ->needChildren(true)

src/applications/diviner/controller/DivinerBookController.php

@@ -46,6 +46,8 @@ final class DivinerBookController extends DivinerController {
     $atoms = id(new DivinerAtomQuery())
       ->setViewer($viewer)
       ->withBookPHIDs(array($book->getPHID()))
+      ->withGhosts(false)
+      ->withIsDocumentable(true)
       ->execute();
 
     $atoms = msort($atoms, 'getSortKey');

src/applications/diviner/controller/DivinerFindController.php

@@ -41,6 +41,9 @@ final class DivinerFindController extends DivinerController {
       $query->withTypes(array($type));
     }
 
+    $query->withGhosts(false);
+    $query->withIsDocumentable(true);
+
     $name_query = clone $query;
 
     $name_query->withNames(

src/applications/diviner/publisher/DivinerLivePublisher.php

@@ -64,7 +64,7 @@ final class DivinerLivePublisher extends DivinerPublisher {
     $symbols = id(new DivinerAtomQuery())
       ->setViewer(PhabricatorUser::getOmnipotentUser())
       ->withBookPHIDs(array($this->loadBook()->getPHID()))
-      ->withIncludeUndocumentable(true)
+      ->withGhosts(false)
       ->execute();
 
     return mpull($symbols, 'getGraphHash');

src/applications/diviner/query/DivinerAtomQuery.php

@@ -9,8 +9,8 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
   private $types;
   private $contexts;
   private $indexes;
-  private $includeUndocumentable;
+  private $isDocumentable;
-  private $includeGhosts;
+  private $isGhost;
   private $nodeHashes;
   private $titles;
   private $nameContains;
@@ -81,9 +81,9 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
 
 
   /**
-   * Include "ghosts", which are symbols which used to exist but do not exist
+   * Include or exclude "ghosts", which are symbols which used to exist but do
-   * currently (for example, a function which existed in an older version of
+   * not exist currently (for example, a function which existed in an older
-   * the codebase but was deleted).
+   * version of the codebase but was deleted).
    *
    * These symbols had PHIDs assigned to them, and may have other sorts of
    * metadata that we don't want to lose (like comments or flags), so we don't
@@ -92,14 +92,11 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
    * have been generated incorrectly by accident. In these cases, we can
    * restore the original data.
    *
-   * However, most callers are not interested in these symbols, so they are
+   * @param bool
-   * excluded by default. You can use this method to include them in results.
-   *
-   * @param bool  True to include ghosts.
    * @return this
    */
-  public function withIncludeGhosts($include) {
+  public function withGhosts($ghosts) {
-    $this->includeGhosts = $include;
+    $this->isGhost = $ghosts;
     return $this;
   }
 
@@ -108,8 +105,8 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
     return $this;
   }
 
-  public function withIncludeUndocumentable($include) {
+  public function withIsDocumentable($documentable) {
-    $this->includeUndocumentable = $include;
+    $this->isDocumentable = $documentable;
     return $this;
   }
 
@@ -346,16 +343,19 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
         $this->indexes);
     }
 
-    if (!$this->includeUndocumentable) {
+    if ($this->isDocumentable !== null) {
       $where[] = qsprintf(
         $conn_r,
-        'isDocumentable = 1');
+        'isDocumentable = %d',
+        (int)$this->isDocumentable);
     }
 
-    if (!$this->includeGhosts) {
+    if ($this->isGhost !== null) {
-      $where[] = qsprintf(
+      if ($this->isGhost) {
-        $conn_r,
+        $where[] = qsprintf($conn_r, 'graphHash IS NULL');
-        'graphHash IS NOT NULL');
+      } else {
+        $where[] = qsprintf($conn_r, 'graphHash IS NOT NULL');
+      }
     }
 
     if ($this->nodeHashes) {

src/applications/diviner/storage/DivinerLiveBook.php

@@ -93,8 +93,6 @@ final class DivinerLiveBook extends DivinerDAO
       $atoms = id(new DivinerAtomQuery())
         ->setViewer($engine->getViewer())
         ->withBookPHIDs(array($this->getPHID()))
-        ->withIncludeGhosts(true)
-        ->withIncludeUndocumentable(true)
         ->execute();
 
       foreach ($atoms as $atom) {