Merge pull request #701 from dart-lang/devoncarew_windows_bug

fix a bug generating windows element links

Author: devoncarew

lib/markdown_processor.dart

@@ -253,21 +253,18 @@ String _getMatchingLink(
       }
     }
   }
-  if (refElement == null) {
-    return null;
-  }
+
+  if (refElement == null) return null;
+
   var refLibrary;
-  try {
-    var e = refElement is ClassMemberElement ||
-            refElement is PropertyAccessorElement
-        ? refElement.enclosingElement
-        : refElement;
-    refLibrary =
-        element.package.libraries.firstWhere((lib) => lib.hasInNamespace(e));
-  } on StateError {}
+  var e = refElement is ClassMemberElement ||
+          refElement is PropertyAccessorElement
+      ? refElement.enclosingElement
+      : refElement;
+  refLibrary = element.package.libraries.firstWhere(
+      (lib) => lib.hasInNamespace(e), orElse: () => null);
   if (refLibrary != null) {
-    var e = new ModelElement.from(refElement, refLibrary);
-    return e.href;
+    return new ModelElement.from(refElement, refLibrary).href;
   }
   return null;
 }

lib/src/model.dart

@@ -139,9 +139,7 @@ abstract class ModelElement implements Comparable {
 
   String get documentationAsHtml {
     if (_documentationAsHtml != null) return _documentationAsHtml;
-
     _documentationAsHtml = processDocsAsMarkdown(this);
-
     return _documentationAsHtml;
   }
 
@@ -491,7 +489,10 @@ class Library extends ModelElement {
   bool hasInNamespace(Element element) {
     if (_namespace == null) _buildExportedNamespace();
     var e = _namespace.get(element.name);
-    return e == element;
+    // Fix for #587, comparison between elements isn't reliable.
+    //return e == element;
+    return e.runtimeType == element.runtimeType &&
+        e.nameOffset == element.nameOffset;
   }
 
   String get name {
@@ -1163,19 +1164,23 @@ class Field extends ModelElement {
   String get _computeDocumentationComment {
     var buffer = new StringBuffer();
     if (hasGetter) {
-      buffer.write(_field.getter.computeDocumentationComment());
+      String docs = _field.getter.computeDocumentationComment();
+      if (docs != null) buffer.write(docs);
     }
 
     if (hasSetter) {
-      if (buffer.isNotEmpty) buffer.write('\n\n');
-      buffer.write(_field.setter.computeDocumentationComment());
+      String docs = _field.setter.computeDocumentationComment();
+      if (docs != null) {
+        if (buffer.isNotEmpty) buffer.write('\n\n');
+        buffer.write(docs);
+      }
     }
 
-    if (buffer.isEmpty) {
-      buffer.write(_field.computeDocumentationComment());
-    } else {
-      return buffer.toString();
-    }
+    if (hasGetter || hasSetter) return buffer.toString();
+
+    String docs = _field.computeDocumentationComment();
+    if (docs != null) buffer.write(docs);
+    return buffer.toString();
   }
 
   void _setModelType() {

test/model_test.dart

@@ -222,22 +222,16 @@ void main() {
           '<a href="ex/Apple/Apple.fromString.html">new Apple.fromString</a>'));
     });
 
-    // On Windows, this test fails due to not being able to find the library that
-    // contains class Apple, checking in namespace does not work.
-    // TODO(keertip): figure out why the element returned from namespace is not
-    // the same as the one we are checking for.
-    if (!Platform.isWindows) {
-      test('reference to class from another library', () {
-        String comment = superAwesomeClass.documentationAsHtml;
-        expect(comment, contains('<a href="ex/Apple-class.html">Apple</a>'));
-      });
-
-      test('reference to method', () {
-        String comment = foo2.documentationAsHtml;
-        expect(comment, equals(
-            '<p>link to method from class <a href="ex/Apple/m.html">Apple.m</a></p>'));
-      });
-    }
+    test('reference to class from another library', () {
+      String comment = superAwesomeClass.documentationAsHtml;
+      expect(comment, contains('<a href="ex/Apple-class.html">Apple</a>'));
+    });
+
+    test('reference to method', () {
+      String comment = foo2.documentationAsHtml;
+      expect(comment, equals(
+          '<p>link to method from class <a href="ex/Apple/m.html">Apple.m</a></p>'));
+    });
 
     test('legacy code blocks render correctly', () {
       expect(testingCodeSyntaxInOneLiners.oneLineDoc,

test/package_meta_test.dart

@@ -63,8 +63,7 @@ void main() {
     });
 
     test('getReadmeContents()', () {
-      // TODO: This is null for SDK 1.10.
-      //expect(p.getReadmeContents(), isNotNull);
+      expect(p.getReadmeContents(), isNotNull);
     });
 
     test('getLicenseContents()', () {

test/template_test.dart

@@ -25,7 +25,7 @@ void main() {
       });
 
       test('render', () {
-        expect(sitemap({'links': [{'name': 'somefile.html'}]}), '''
+        expect(_normalize(sitemap({'links': [{'name': 'somefile.html'}]})), '''
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
@@ -36,9 +36,9 @@ void main() {
       });
 
       test('substitute multiple links', () {
-        expect(sitemap({
+        expect(_normalize(sitemap({
           'links': [{'name': 'somefile.html'}, {'name': 'asecondfile.html'}]
-        }), '''
+        })), '''
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
@@ -52,10 +52,10 @@ void main() {
       });
 
       test('url and file name', () {
-        expect(sitemap({
+        expect(_normalize(sitemap({
           'url': 'http://mydoc.com',
           'links': [{'name': 'somefile.html'}]
-        }), '''
+        })), '''
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
@@ -67,3 +67,5 @@ void main() {
     });
   });
 }
+
+String _normalize(String str) => str.replaceAll('\r\n', '\n');

test_package/lib/example.dart

@@ -51,6 +51,7 @@ class Apple {
 
   void paramFromExportLib(Helper helper) {}
 }
+
 /// Extends class [Apple], use [new Apple] or [new Apple.fromString]
 class B extends Apple with Cat {
   List<String> list;