gitlab_kramdown 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1300ec014cee9ac392ba0934415585953a90c1d
-  data.tar.gz: 252c205835324990971e33f54a34e59bab01203e
+  metadata.gz: ce8545ba899795f6dc56a1719b4b34f61b2a4658
+  data.tar.gz: 18241d90cfb9fa02b4115fc5d4f1fb388d2896e1
 SHA512:
-  metadata.gz: e87efac88a9b5c980a67a8c6f74da59cf4b0bfa07d95d0b148ccc6db536380bc10f8a5a40c9bd3de860fa35a20aa850b7a0f9ed003a2ee39cd254971f9bc794e
-  data.tar.gz: aea0b96c06aaeba06ce712eb984b8ceb5eb754333ed321aef5ff1ef1c6372be97b406d5257a616e32be9adc6a29eb66207ad669c2e5f2b78b9cda1785a3cfde5
+  metadata.gz: 6813cb7bf833a30a9a19090caab8f4bf4b5e55d9f006c85cbc3f7bbaa42dd21a2e70f6f3b4236e642c9315b35a398799297ee45556b1df9a8c6a0aaa6a73c38e
+  data.tar.gz: 82fc613035d1a7a9864cb22142aeef407a76331d3be7c7ba7fecd2d7da2ea3b7e6ec5dc7bc00af731e2a0e13e200dd3551e6dbe4a0c6e348b3fe3c93d810e7ee

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.4.0] - 2018-04-12
+### Added
+- URL auto-linking support
+
+### Changed
+- Fixed many inconsistencies in references autolink
+
 ## [0.3.0] - 2018-03-23
 ### Added
 - Headers will include by default an anchor tag (you can disable with `linkable_headers: false`)

data/README.md

@@ -11,7 +11,7 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [Newlines]                      | No           |
 | [Multiple underscores in words] | _Kramdown_   |
 | [Headers with Anchors]          | **Yes**      |
-| [URL auto-linking]              | No           |
+| [URL auto-linking]              | **Yes**      |
 | [Multiline Blockquote]          | **Yes**      |
 | [Code and Syntax Highlighting]  | **Yes**      |
 | [Inline Diff]                   | No           |

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/gitlab_kramdown.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: gitlab_kramdown 0.3.0 ruby lib
+# stub: gitlab_kramdown 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gitlab_kramdown".freeze
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Gabriel Mazetto".freeze]
-  s.date = "2018-03-23"
+  s.date = "2018-04-12"
   s.description = "GitLab Flavored Markdown extensions on top of Kramdown markup. Tries to be as close as possible to existing extensions.".freeze
   s.email = "brodock@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -33,11 +33,14 @@ Gem::Specification.new do |s|
     "gitlab_kramdown.gemspec",
     "lib/gitlab_kramdown.rb",
     "lib/gitlab_kramdown/parser.rb",
+    "lib/gitlab_kramdown/parser/autolink.rb",
     "lib/gitlab_kramdown/parser/fenced_blockquote.rb",
     "lib/gitlab_kramdown/parser/fenced_codeblock.rb",
     "lib/gitlab_kramdown/parser/header.rb",
     "lib/gitlab_kramdown/parser/reference.rb",
     "lib/kramdown/parser/gitlab_kramdown.rb",
+    "spec/fixtures/autolink.html",
+    "spec/fixtures/autolink.text",
     "spec/fixtures/code_highlight.html",
     "spec/fixtures/code_highlight.text",
     "spec/fixtures/header.html",

data/lib/gitlab_kramdown/parser/autolink.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # URL auto-linking
+    #
+    # This parser implements URL auto-linking support for the most widely used schemas
+    #
+    # @see https://docs.gitlab.com/ee/user/markdown.html#url-auto-linking
+    module Autolink
+      PUNCTUATION_PAIRS = /['"][)\]}][(\[{]/
+      ACHARS = /[[:alnum:]]_/
+
+      AUTOLINK_START = %r{
+        (
+          (?<schema>mailto|https?|ftps?|irc|smb):[^\s>]+(?<!\?|!|\.|,|:)
+            |
+          [-.[[:alnum:]]_]+@[-[[:alnum:]]_]+(?:\.[-[[:alnum:]]_]+)*\.[a-z]+
+        )
+      }x
+
+      def self.included(klass)
+        klass.define_parser(:gitlab_autolink, AUTOLINK_START)
+      end
+
+      # Parse the autolink at the current location.
+      def parse_gitlab_autolink
+        start_line_number = @src.current_line_number
+        @src.pos += @src.matched_size
+
+        href = (@src[:schema].nil? ? "mailto:#{@src[0]}" : @src[0])
+        el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
+
+        add_text(@src[0].sub(/^mailto:/, ''), el)
+        @tree.children << el
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser/reference.rb

@@ -9,23 +9,23 @@ module GitlabKramdown
     #
     # @see https://docs.gitlab.com/ee/user/markdown.html#special-gitlab-references
     module Reference
-      PATH_REGEX_STR = '[a-zA-Z0-9_\.][a-zA-Z0-9_\-\.]*'
+      PATH_REGEX = /[a-zA-Z0-9_\.][a-zA-Z0-9_\-\.]*/
 
       NAMESPACE_FORMAT_REGEX = %r{
-        (?:#{PATH_REGEX_STR}[a-zA-Z0-9_\-]|[a-zA-Z0-9_])
+        (?:#{PATH_REGEX}[a-zA-Z0-9_\-]|[a-zA-Z0-9_])
         (?<!\.git|\.atom)
       }x
 
       FULL_NAMESPACE_FORMAT_REGEX = %r{(#{NAMESPACE_FORMAT_REGEX}/)*#{NAMESPACE_FORMAT_REGEX}}
+      ALWAYS_FULL_NAMESPACE_FORMAT_REGEX = %r{(#{NAMESPACE_FORMAT_REGEX}/)+#{NAMESPACE_FORMAT_REGEX}}
 
       USER_GROUP_PATTERN = %r{
-        (?<!\w)
         #{Regexp.escape('@')}
         (?<user>#{FULL_NAMESPACE_FORMAT_REGEX})
       }x
 
       PROJECT_COMMIT_PATTERN = %r{
-        (?<namespace>#{FULL_NAMESPACE_FORMAT_REGEX})
+        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('@')}
         (?<commit>[a-z0-9]+)
         (?!\.{3})
@@ -34,9 +34,9 @@ module GitlabKramdown
       PROJECT_COMMIT_DIFF_PATTERN = %r{
         (?<namespace>#{FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('@')}
-        (?<commit_source>[a-z0-9]+)
+        (?<commit_source>[a-f0-9]+)
         \.{3}
-        (?<commit_target>[a-z0-9]+)
+        (?<commit_target>[a-f0-9]+)
       }x
 
       PROJECT_ISSUE_PATTERN = %r{
@@ -80,6 +80,12 @@ module GitlabKramdown
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
+        # should not start with anything that looks like project/namespace
+        if @src.pre_match.match?(/[a-zA-Z0-9_\-]\Z/)
+          add_text(@src[0])
+          return
+        end
+
         href = "#{@options[:gitlab_url]}/#{@src[:user]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)

data/lib/gitlab_kramdown/parser.rb

@@ -9,5 +9,6 @@ module GitlabKramdown
     autoload :FencedCodeblock, 'gitlab_kramdown/parser/fenced_codeblock'
     autoload :Header, 'gitlab_kramdown/parser/header'
     autoload :Reference, 'gitlab_kramdown/parser/reference'
+    autoload :Autolink, 'gitlab_kramdown/parser/autolink'
   end
 end

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -13,6 +13,7 @@ module Kramdown
       include ::GitlabKramdown::Parser::FencedCodeblock
       include ::GitlabKramdown::Parser::Header
       include ::GitlabKramdown::Parser::Reference
+      include ::GitlabKramdown::Parser::Autolink
 
       def initialize(source, options)
         super
@@ -21,7 +22,8 @@ module Kramdown
         @options[:linkable_headers] = true if @options[:linkable_headers].nil?
         @id_counter = Hash.new(-1)
 
-        prepend_span_parsers(:commit_diff, :commit, :user_group_mention, :issue, :merge_request, :snippet, :label)
+        prepend_span_parsers(:commit_diff, :commit, :user_group_mention,
+                             :issue, :merge_request, :snippet, :label, :gitlab_autolink)
         prepend_block_parsers(:fenced_blockquote)
         replace_block_parser!(:codeblock_fenced, :codeblock_fenced_gitlab)
         replace_block_parser!(:atx_header, :atx_gitlab_header)

data/spec/fixtures/autolink.html

@@ -0,0 +1,21 @@
+<h1 id="autolinks">Autolinks</h1>
+
+<p>The following URLs will be autolinked:</p>
+
+<ul>
+  <li><a href="https://www.google.com">https://www.google.com</a> ! This is google</li>
+  <li><a href="https://google.com/">https://google.com/</a></li>
+  <li><a href="ftp://ftp.us.debian.org/debian/">ftp://ftp.us.debian.org/debian/</a></li>
+  <li><a href="smb://foo/bar/baz">smb://foo/bar/baz</a></li>
+  <li><a href="irc://irc.freenode.net/gitlab">irc://irc.freenode.net/gitlab</a></li>
+  <li><a href="http://localhost:3000">http://localhost:3000</a></li>
+  <li>This is an email: <a href="mailto:john.doe@example.com">john.doe@example.com</a> .</li>
+  <li>URL with ampersand: <a href="http://www.example.com/?doit&amp;x=y">http://www.example.com/?doit&amp;x=y</a> !</li>
+</ul>
+
+<blockquote>
+  <p>It works even inside other blocks: <a href="https://www.google.com">https://www.google.com</a></p>
+</blockquote>
+
+<pre><code>Doesn't work inside code-blocks: https://www.google.com
+</code></pre>

data/spec/fixtures/autolink.text

@@ -0,0 +1,18 @@
+# Autolinks
+
+The following URLs will be autolinked:
+
+* https://www.google.com ! This is google
+* https://google.com/
+* ftp://ftp.us.debian.org/debian/
+* smb://foo/bar/baz
+* irc://irc.freenode.net/gitlab
+* http://localhost:3000
+* This is an email: john.doe@example.com .
+* URL with ampersand: http://www.example.com/?doit&x=y !
+
+> It works even inside other blocks: https://www.google.com
+
+```
+Doesn't work inside code-blocks: https://www.google.com
+```

data/spec/fixtures/references.html

@@ -2,13 +2,15 @@
 
 <p>Group: <a href="https://gitlab.com/group_name">@group_name</a></p>
 
+<p>Subgroup: <a href="https://gitlab.com/maingroup123/group_name">@maingroup123/group_name</a></p>
+
 <p>Project Issue: <a href="https://gitlab.com/group_name/project_name/issues/12345">group_name/project_name#12345</a></p>
 
 <p>Merge Request: <a href="https://gitlab.com/group_name/project_name/merge_requests/12345">group_name/project_name!12345</a></p>
 
 <p>Project Snippet: <a href="https://gitlab.com/group_name/project_name/snippets/12345">group_name/project_name$12345</a></p>
 
-<p>Project Commit: <a href="https://gitlab.com/group_name/project_name/commit/9ba12248">group_name/project_name@9ba12248</a></p>
+<p>Project Commit: <a href="https://gitlab.com/group_name/project_name/commit/9ba12248">group_name/project_name@9ba12248</a> not to get confused by email: <a href="mailto:john.doe@example.com">john.doe@example.com</a></p>
 
 <p>Project Commit Range comparison: <a href="https://gitlab.com/group_name/project_name/compare/9ba12248...b19a04f5">group_name/project_name@9ba12248...b19a04f5</a></p>
 

data/spec/fixtures/references.text

@@ -2,13 +2,15 @@ User: @user_name
 
 Group: @group_name
 
+Subgroup: @maingroup123/group_name
+
 Project Issue: group_name/project_name#12345
 
 Merge Request: group_name/project_name!12345
 
 Project Snippet: group_name/project_name$12345
 
-Project Commit: group_name/project_name@9ba12248
+Project Commit: group_name/project_name@9ba12248 not to get confused by email: john.doe@example.com
 
 Project Commit Range comparison: group_name/project_name@9ba12248...b19a04f5
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -145,11 +145,14 @@ files:
 - gitlab_kramdown.gemspec
 - lib/gitlab_kramdown.rb
 - lib/gitlab_kramdown/parser.rb
+- lib/gitlab_kramdown/parser/autolink.rb
 - lib/gitlab_kramdown/parser/fenced_blockquote.rb
 - lib/gitlab_kramdown/parser/fenced_codeblock.rb
 - lib/gitlab_kramdown/parser/header.rb
 - lib/gitlab_kramdown/parser/reference.rb
 - lib/kramdown/parser/gitlab_kramdown.rb
+- spec/fixtures/autolink.html
+- spec/fixtures/autolink.text
 - spec/fixtures/code_highlight.html
 - spec/fixtures/code_highlight.text
 - spec/fixtures/header.html