Replace BazelWorkspace factory with the static 'find' method.

pkg/analyzer/lib/src/generated/bazel.dart

 // Copyright (c) 2016, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library analyzer.src.generated.bazel;
 
 import 'dart:collection';
 import 'dart:core';
 
 import 'package:analyzer/file_system/file_system.dart';
@@ skipping 103 matching lines @@
   /**
    * The absolute path to the `bazel-bin` folder.
    */
   final String bin;
 
   /**
    * The absolute path to the `bazel-genfiles` folder.
    */
   final String genfiles;
 
-  /**
-   * Create a new Bazel workspace that contains the given [path].
-   *
-   * The [symlinkPrefix] is the prefix for names of symlinks like `bazel-bin`,
-   * `bazel-genfiles`, etc.
-   */
-  factory BazelWorkspace(ResourceProvider provider, String path,
-      {String symlinkPrefix: 'bazel', String readonlySuffix}) {
-    Context context = provider.pathContext;
-
-    // Ensure that the path is absolute and normalized.
-    if (!context.isAbsolute(path)) {
-      throw new ArgumentError('not absolute: $path');
-    }
-    path = context.normalize(path);
-
-    Folder folder = provider.getFolder(path);
-    while (true) {
-      Folder parent = folder.parent;
-
-      // Found the READONLY folder, must be a git-based workspace.
-      if (readonlySuffix != null && parent != null) {
-        Folder readonlyFolder = parent.getChildAssumingFolder(_READONLY);
-        if (readonlyFolder.exists) {
-          String root = folder.path;
-          String readonly = readonlyFolder.path;
-          return new BazelWorkspace._(
-              provider,
-              root,
-              context.join(readonly, readonlySuffix),
-              context.join(root, '$symlinkPrefix-bin'),
-              context.join(root, '$symlinkPrefix-genfiles'));
-        }
-      }
-
-      // Found the WORKSPACE file, must be a non-git workspace.
-      if (folder.getChildAssumingFile(_WORKSPACE).exists) {
-        String root = folder.path;
-        return new BazelWorkspace._(
-            provider,
-            root,
-            null,
-            context.join(root, '$symlinkPrefix-bin'),
-            context.join(root, '$symlinkPrefix-genfiles'));
-      }
-
-      // Go up the folder.
-      folder = parent;
-      if (folder == null) {
-        return new BazelWorkspace._(provider, path, null, null, null);
-      }
-    }
-  }
-
   BazelWorkspace._(
       this.provider, this.root, this.readonly, this.bin, this.genfiles);
 
   /**
    * Return the file with the given [absolutePath], looking first into
-   * directories for generated files: `bazel-genfiles` and `bazel-bin`, and
+   * directories for generated files: `bazel-bin` and `bazel-genfiles`, and
    * then into the workspace root. The file in the workspace root is returned
    * even if it does not exist. Return `null` if the given [absolutePath] is
    * not in the workspace [root].
    */
   File findFile(String absolutePath) {
     Context context = provider.pathContext;
     try {
       String relative = context.relative(absolutePath, from: root);
       // genfiles
       if (genfiles != null) {
@@ skipping 23 matching lines @@
     }
   }
 
   /**
    * Return the file for the given [pathInWorkspace]. The file is returned even
    * if it does not exist.
    */
   File getFile(String pathInWorkspace) {
     return provider.getFile(provider.pathContext.join(root, pathInWorkspace));
   }
+
+  /**
+   * Find the Bazel workspace that contains the given [path].
+   *
+   * The [symlinkPrefix] is the prefix for names of symlinks like `bazel-bin`,
+   * `bazel-genfiles`, etc.
+   */

[Paul Berry, 2016/10/07 17:08:36]

Can you add a line to the doc comment explaining when find() is expected to
return null?

[scheglov, 2016/10/07 17:15:56]

Done.

+  static BazelWorkspace find(ResourceProvider provider, String path,
+      {String symlinkPrefix: 'bazel', String readonlySuffix}) {
+    Context context = provider.pathContext;
+
+    // Ensure that the path is absolute and normalized.
+    if (!context.isAbsolute(path)) {
+      throw new ArgumentError('not absolute: $path');
+    }
+    path = context.normalize(path);
+
+    Folder folder = provider.getFolder(path);
+    while (true) {
+      Folder parent = folder.parent;
+      if (parent == null) {
+        return null;
+      }
+
+      // Found the READONLY folder, must be a git-based workspace.
+      if (readonlySuffix != null && parent != null) {

[Paul Berry, 2016/10/07 17:08:36]

You can drop `&& parent != null` from this line because of the null check above.

[scheglov, 2016/10/07 17:15:56]

Done.

+        Folder readonlyFolder = parent.getChildAssumingFolder(_READONLY);
+        if (readonlyFolder.exists) {
+          String root = folder.path;
+          String readonly = readonlyFolder.path;
+          return new BazelWorkspace._(
+              provider,
+              root,
+              context.join(readonly, readonlySuffix),
+              context.join(root, '$symlinkPrefix-bin'),
+              context.join(root, '$symlinkPrefix-genfiles'));
+        }
+      }
+
+      // Found the WORKSPACE file, must be a non-git workspace.
+      if (folder.getChildAssumingFile(_WORKSPACE).exists) {
+        String root = folder.path;
+        return new BazelWorkspace._(
+            provider,
+            root,
+            null,
+            context.join(root, '$symlinkPrefix-bin'),
+            context.join(root, '$symlinkPrefix-genfiles'));
+      }
+
+      // Go up the folder.
+      folder = parent;
+    }
+  }
 }