Strip scheme (#1294)

* Add _AutolinkWithoutScheme

* Update test docs for new behavior of fake library

* Local pubspec change

* Update version to 0.9.9 and regen docs

* dartfmt for markdown_processor.dart

* fix merge conflict notes that got left behind

* Adjust offset in crossdart test... doesn't seem to work

* clean up pubspec.yaml

* Dynamically compute offset for crossdartify test

* regenerate docs

* pubspec.lock minimally updated

Author: jcollins-g

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.9+1
+* Add support for stripping schema from display text for urls defined with
+  brackets (#1147)
+
 ## 0.9.9
 * resolve non-imported symbols in comments (#1153) - thanks @astashov!
 * support `@example` insertion of .md file fragments (#1105) - thanks @chalin!

lib/dartdoc.dart

@@ -40,7 +40,7 @@ export 'src/package_meta.dart';
 
 const String name = 'dartdoc';
 // Update when pubspec version changes.
-const String version = '0.9.9';
+const String version = '0.9.9+1';
 
 final String defaultOutDir = path.join('doc', 'api');
 

lib/src/markdown_processor.dart

@@ -36,7 +36,13 @@ final nonHTMLRegexp = new RegExp("</?(?!(${validHtmlTags.join("|")})[> ])\\w+[>
 // We don't emit warnings currently: #572.
 const List<String> _oneLinerSkipTags = const ["code", "pre"];
 
-final List<md.InlineSyntax> _markdown_syntaxes = [new _InlineCodeSyntax()];
+final List<md.InlineSyntax> _markdown_syntaxes = [
+  new _InlineCodeSyntax(),
+  new _AutolinkWithoutScheme()
+];
+
+// Remove these schemas from the display text for hyperlinks.
+final RegExp _hide_schemes = new RegExp('^(http|https)://');
 
 class MatchingLinkResult {
   final ModelElement element;
@@ -307,3 +313,16 @@ class _InlineCodeSyntax extends md.InlineSyntax {
     return true;
   }
 }
+
+class _AutolinkWithoutScheme extends md.AutolinkSyntax {
+  @override
+  bool onMatch(md.InlineParser parser, Match match) {
+    var url = match[1];
+    var text = md.escapeHtml(url).replaceFirst(_hide_schemes, '');
+    var anchor = new md.Element.text('a', text);
+    anchor.attributes['href'] = url;
+    parser.addNode(anchor);
+
+    return true;
+  }
+}

pubspec.lock

@@ -120,7 +120,7 @@ packages:
       name: markdown
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.11.1"
+    version: "0.11.2"
   matcher:
     description:
       name: matcher

pubspec.yaml

@@ -1,6 +1,6 @@
 name: dartdoc
 # Also update the `version` field in lib/dartdoc.dart.
-version: 0.9.9
+version: 0.9.9+1
 author: Dart Team <[email protected]>
 description: A documentation generator for Dart.
 homepage: https://github.com/dart-lang/dartdoc
@@ -15,7 +15,7 @@ dependencies:
   # least version 3.0.3 to work around an issue with 3.0.2.
   http_parser: '>=3.0.3 <4.0.0'
   logging: '>=0.9.0 <0.12.0'
-  markdown: ^0.11.1
+  markdown: ^0.11.2
   mustache4dart: ^1.0.9
   package_config: '>=0.1.5 <2.0.0'
   path: ^1.3.0

test/model_test.dart

@@ -1010,14 +1010,20 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
     test('method source code crossdartifies correctly', () {
       convertToMap.clearSourceCodeCache();
       var fakePath = "testing/test_package/lib/fake.dart";
+      var offset = new File(fakePath)
+          .readAsStringSync()
+          .indexOf('Map<X, Y> convertToMap');
+      expect(offset, isNonNegative,
+             reason: "Can't find convertToMap function in ${fakePath}");
       if (Platform.isWindows) fakePath = fakePath.replaceAll('/', r'\\');
       new File(p.join(Directory.current.path, "crossdart.json"))
           .writeAsStringSync("""
               {"$fakePath":
-                {"references":[{"offset":1069,"end":1072,"remotePath":"http://www.example.com/fake.dart"}]}}
+                {"references":[{"offset":${offset},"end":${offset+3},"remotePath":"http://www.example.com/fake.dart"}]}}
       """);
 
       initializeConfig(addCrossdart: true, inputDir: Directory.current);
+
       expect(convertToMap.sourceCode,
           "<a class='crossdart-link' href='http://www.example.com/fake.dart'>Map</a>&lt;X, Y&gt; convertToMap() =&gt; null;");
     });

testing/test_package/lib/fake.dart

@@ -37,6 +37,12 @@
 /// }
 /// ```
 ///
+/// Here are some hyperlinks with angle brackets:
+///
+/// * <https://myfakepackage.com/withapath>
+/// * <ftp://ftp.myfakepackage.com/donthidemyschema>
+/// * <http://myfakepackage.com/buthidethisone>
+///
 /// [pkg]: http://example.org
 library fake;
 

testing/test_package_docs/fake/fake-library.html

@@ -111,6 +111,7 @@ <h5>I am an h5</h5>
   long line is very long long line is very long long line is very long line long line long line
 }
 </code></pre>
+<p>Here are some hyperlinks with angle brackets:</p><ul><li><a href="https://myfakepackage.com/withapath">myfakepackage.com/withapath</a></li><li><a href="ftp://ftp.myfakepackage.com/donthidemyschema">ftp://ftp.myfakepackage.com/donthidemyschema</a></li><li><a href="http://myfakepackage.com/buthidethisone">myfakepackage.com/buthidethisone</a></li></ul>
     </section>
 
     <section class="summary offset-anchor" id="constants">

testing/test_package_docs/index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <meta name="generator" content="made with love by dartdoc 0.9.9">
+  <meta name="generator" content="made with love by dartdoc 0.9.9+1">
   <meta name="description" content="test_package API docs, for the Dart programming language.">
   <title>test_package - Dart API docs</title>