gitlab_kramdown 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11a7015bbdc9b75dd012b666454950b287ba91dacdbabf260926524715d5ce6
-  data.tar.gz: b396022c54535f3e0d3b519a0d9f6d0e20e55f1f4d86e8535f9be785aeaf4de7
+  metadata.gz: 517b3887d49cee2247f49be6b18fa0cbb6c4c18e7af3665ba7ff5ef176a76605
+  data.tar.gz: 59cde8e22215f041764f87129bea76d3437812c80514bd7aea9051766fc5662d
 SHA512:
-  metadata.gz: e9530ea7bd5c430853f76c05bd0949c2dbf9aa7c1368c05b7018789299c6cbf61df37ab60476c711ad1db2d073d90069be28033c6b0edf897f73c362c1bb39fd
-  data.tar.gz: 319d2a71cce247af61b2c7b8c67cb5538a2d894a0e081a55ea9ebd54af6caa1bc8280adea79344022e78bd7087fa16444d2386729af596ad3fc39b6e36bea8f1
+  metadata.gz: 4aabf0787861f334bf0e500a49ef9cd678beae3a3fba429d772df8e100b99980d9951e302c0e6a1d6502e8594671391841cdfcfba46f5c4e4500ec643eb2b3d7
+  data.tar.gz: 96ea79c38638a5f800dd457c904114179a2ab4bf478bd6aa2e3b9cb4db37227e12ce363d73e38c215de6fe6c5d2a7e82dd164b2b5c40c8cda42b0f073b0e0c67

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.16.0] - 2022-24-01
+
+### Fixed
+
+- Namespaced References are correctly extracted when `autolink: false`
+
+### Changed
+
+- Update minimum supported Ruby to 2.7.5
+- Labels are now converted to an HTML similar to GitLab
+- Labels were extracted to its own parser module
+
 ## [0.15.0] - 2021-12-20
 
 ### Changes
@@ -144,20 +156,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Special GitLab References
 - Multiline Blockquote
 
-[0.15.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.14.0...v0.15.0
-[0.14.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.13.0...v0.14.0
-[0.13.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.12.0...v0.13.0
-[0.12.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.11.0...v0.12.0
-[0.11.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.10.0...v0.11.0
-[0.10.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.9.0...v0.10.0
-[0.9.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.8.0...v0.9.0
-[0.8.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.7.0...v0.8.0
-[0.7.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.6.0...v0.7.0
-[0.6.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.5.0...v0.6.0
-[0.5.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.4.2...v0.5.0
-[0.4.2]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.4.1...v0.4.2
-[0.4.1]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.4.0...v0.4.1
-[0.4.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.3.0...v0.4.0
-[0.3.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.2.0...v0.3.0
-[0.2.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/v0.1.0...v0.2.0
-[0.1.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/compare/15b5e4b46aa0e42974ec2e5ee36c68d97219736f...v0.1.0
+[0.16.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.15.0...v0.16.0
+[0.15.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.14.0...v0.15.0
+[0.14.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.13.0...v0.14.0
+[0.13.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.12.0...v0.13.0
+[0.12.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.11.0...v0.12.0
+[0.11.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.10.0...v0.11.0
+[0.10.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.9.0...v0.10.0
+[0.9.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.8.0...v0.9.0
+[0.8.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.7.0...v0.8.0
+[0.7.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.6.0...v0.7.0
+[0.6.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.5.0...v0.6.0
+[0.5.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.4.2...v0.5.0
+[0.4.2]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.4.1...v0.4.2
+[0.4.1]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.4.0...v0.4.1
+[0.4.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.3.0...v0.4.0
+[0.3.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.2.0...v0.3.0
+[0.2.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/v0.1.0...v0.2.0
+[0.1.0]: https://gitlab.com/gitlab-org/gitlab_kramdown/-/compare/15b5e4b46aa0e42974ec2e5ee36c68d97219736f...v0.1.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2019 Gabriel Mazetto
+Copyright (c) 2018-2022 Gabriel Mazetto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -74,6 +74,7 @@ Kramdown::Document.new(source, input: 'GitlabKramdown', syntax_highlighter: :rou
 ## Supported and tested Ruby versions
 
 - Ruby 2.7
+- Ruby 3.0
 
 ## Release a new version
 
@@ -96,7 +97,7 @@ To release a new version of GitLab Kramdown:
 
 ## Copyright
 
-Copyright (c) 2018-2019 Gabriel Mazetto. See LICENSE.txt for
+Copyright (c) 2018-2022 Gabriel Mazetto. See LICENSE.txt for
 further details.
 
 [GitLab flavored Markdown]: https://docs.gitlab.com/ee/user/markdown.html

data/lib/gitlab_kramdown/converter/gitlab_html.rb

@@ -68,6 +68,21 @@ module GitlabKramdown
 
         %(<a href="#{href}" target="_blank" rel="noopener noreferrer">#{super}</a>)
       end
+
+      # Label element is generated by the GitlabKramdown parser, representing GitLab labels
+      #
+      # It includes the following attributes:
+      # - +href+: the URL for the label
+      # - +label+: the name of the label without namespace part
+      # - +namespace+: the namespace part of the label
+      def convert_label(element, _indent)
+        label_attrs = { class: 'badge color-label' }
+
+        label_text = "#{element.attr['label']} in <i>#{element.attr['namespace']}</i>"
+        span_tag = format_as_span_html(:span, label_attrs, label_text)
+
+        format_as_span_html(:a, { 'href' => element.attr['href'] }, span_tag)
+      end
     end
   end
 end

data/lib/gitlab_kramdown/parser/label.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # GitLab Labels
+    #
+    # This parser implements non context-specific label references as described
+    # in the GitLab Flavored Markdown reference
+    #
+    # @see https://docs.gitlab.com/ee/user/markdown.html#special-gitlab-references
+    module Label
+      PROJECT_LABEL_PATTERN = %r{
+        #{Regexp.escape('~')}
+        (?<label>
+          [A-Za-z0-9_\-?.&]+ | # String-based single-word label title, or
+          ".+?"                # String-based multi-word label surrounded in quotes
+        )
+      }x.freeze
+
+      def self.included(klass)
+        klass.define_parser(:label, PROJECT_LABEL_PATTERN, '\~')
+      end
+
+      def parse_label
+        start_line_number = @src.current_line_number
+        @src.pos += @src.matched_size
+
+        namespace = extract_reference_namespace!
+
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
+
+          return
+        end
+
+        label_name = @src[:label].delete('"')
+        label_param = label_name.tr(' ', '+')
+        href = "#{@options[:gitlab_url]}/#{namespace}/issues?label_name=#{label_param}"
+        label_attrs = { 'href' => href, 'label' => label_name, 'namespace' => namespace }
+
+        el = Kramdown::Element.new(:label, nil, label_attrs, location: start_line_number)
+
+        @tree.children << el
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser/reference.rb

@@ -5,8 +5,10 @@ module GitlabKramdown
     # Special GitLab References
     #
     # This parser implements any non context-specific reference as described
-    # in the GitLab Flavored Markdown reference
+    # in the GitLab Flavored Markdown reference, except for labels which were
+    # extracted into it's own module.
     #
+    # @see GitlabKramdown::Parser::Label
     # @see https://docs.gitlab.com/ee/user/markdown.html#special-gitlab-references
     module Reference
       PATH_REGEX = /[a-zA-Z0-9_.][a-zA-Z0-9_\-.]+/.freeze
@@ -20,20 +22,20 @@ module GitlabKramdown
       FULL_NAMESPACE_FORMAT_REGEX = %r{(#{NAMESPACE_FORMAT_REGEX}/)*#{NAMESPACE_FORMAT_REGEX}}.freeze
       ALWAYS_FULL_NAMESPACE_FORMAT_REGEX = %r{(#{NAMESPACE_FORMAT_REGEX}/)+#{NAMESPACE_FORMAT_REGEX}}.freeze
 
+      NAMESPACE_EXTRACTION_PATTERN = /(?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})\z/.freeze
+
       USER_GROUP_PATTERN = %r{
         #{Regexp.escape('@')}
         (?<user>#{FULL_NAMESPACE_FORMAT_REGEX})
       }x.freeze
 
       PROJECT_COMMIT_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('@')}
         (?<commit>[a-f0-9]{7,40})
         (?!\.{3})
       }x.freeze
 
       PROJECT_COMMIT_DIFF_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('@')}
         (?<commit_source>[a-f0-9]{7,40})
         \.{3}
@@ -41,40 +43,27 @@ module GitlabKramdown
       }x.freeze
 
       PROJECT_ISSUE_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('#')}
         (?<issue>[1-9][0-9]*)
       }x.freeze
 
       PROJECT_MERGE_REQUEST_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('!')}
         (?<merge_request>[1-9][0-9]*)
       }x.freeze
 
       PROJECT_SNIPPET_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
         #{Regexp.escape('$')}
         (?<snippet>[1-9][0-9]*)
       }x.freeze
 
-      PROJECT_LABEL_PATTERN = %r{
-        (?<namespace>#{ALWAYS_FULL_NAMESPACE_FORMAT_REGEX})
-        #{Regexp.escape('~')}
-        (?<label>
-          [A-Za-z0-9_\-?.&]+ | # String-based single-word label title, or
-          ".+?"                  # String-based multi-word label surrounded in quotes
-        )
-      }x.freeze
-
       def self.included(klass)
         klass.define_parser(:user_group_mention, USER_GROUP_PATTERN, '@')
-        klass.define_parser(:commit, PROJECT_COMMIT_PATTERN, '@')
         klass.define_parser(:commit_diff, PROJECT_COMMIT_DIFF_PATTERN, '@')
+        klass.define_parser(:commit, PROJECT_COMMIT_PATTERN, '@')
         klass.define_parser(:issue, PROJECT_ISSUE_PATTERN, '#')
         klass.define_parser(:merge_request, PROJECT_MERGE_REQUEST_PATTERN, '\!')
         klass.define_parser(:snippet, PROJECT_SNIPPET_PATTERN, '\$')
-        klass.define_parser(:label, PROJECT_LABEL_PATTERN, '\~')
       end
 
       def parse_user_group_mention
@@ -94,14 +83,51 @@ module GitlabKramdown
         @tree.children << el
       end
 
+      # Extract namespace after a reference has been found
+      #
+      # This method provides a workaround for the lack of lookbehind support
+      # in Ruby StringScanner.
+      #
+      # We look at pre_match content (everything before the reference in the same line)
+      # and extract the very last word in the string as long as it matches the
+      # NAMESPACE_EXTRACTION_PATTERN.
+      #
+      # We then modify the last parsed tree element's value, removing the matched
+      # namespace, so that we can process that as part of the reference code.
+      #
+      # @see NAMESPACE_EXTRACTION_PATTERN
+      def extract_reference_namespace!
+        data = @src.pre_match.match(NAMESPACE_EXTRACTION_PATTERN)
+
+        if data
+          namespace = data[:namespace]
+
+          # Remove namespace from last parsed tree value
+          redacted = @tree.children.last.value[0..-(namespace.size + 1)]
+          @tree.children.last.value = redacted
+        end
+
+        namespace
+      end
+
       def parse_commit
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/commit/#{@src[:commit]}"
+        namespace = extract_reference_namespace!
+        reference_text = "#{namespace}#{@src[0]}"
+
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
+
+          return
+        end
+
+        href = "#{@options[:gitlab_url]}/#{namespace}/commit/#{@src[:commit]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
+        add_text(reference_text, el)
         @tree.children << el
       end
 
@@ -109,11 +135,21 @@ module GitlabKramdown
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/compare/" \
+        namespace = extract_reference_namespace!
+        reference_text = "#{namespace}#{@src[0]}"
+
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
+
+          return
+        end
+
+        href = "#{@options[:gitlab_url]}/#{namespace}/compare/" \
                "#{@src[:commit_source]}...#{@src[:commit_target]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
+        add_text(reference_text, el)
         @tree.children << el
       end
 
@@ -121,10 +157,20 @@ module GitlabKramdown
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/issues/#{@src[:issue]}"
+        namespace = extract_reference_namespace!
+        reference_text = "#{namespace}#{@src[0]}"
+
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
+
+          return
+        end
+
+        href = "#{@options[:gitlab_url]}/#{namespace}/issues/#{@src[:issue]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
+        add_text(reference_text, el)
         @tree.children << el
       end
 
@@ -132,10 +178,20 @@ module GitlabKramdown
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/merge_requests/#{@src[:merge_request]}"
+        namespace = extract_reference_namespace!
+        reference_text = "#{namespace}#{@src[0]}"
+
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
+
+          return
+        end
+
+        href = "#{@options[:gitlab_url]}/#{namespace}/merge_requests/#{@src[:merge_request]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
+        add_text(reference_text, el)
         @tree.children << el
       end
 
@@ -143,22 +199,20 @@ module GitlabKramdown
         start_line_number = @src.current_line_number
         @src.pos += @src.matched_size
 
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/snippets/#{@src[:snippet]}"
+        namespace = extract_reference_namespace!
+        reference_text = "#{namespace}#{@src[0]}"
 
-        el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
-        @tree.children << el
-      end
+        # If we can't find a namespace we just add content as regular text and skip
+        unless namespace
+          add_text(@src[0])
 
-      def parse_label
-        start_line_number = @src.current_line_number
-        @src.pos += @src.matched_size
+          return
+        end
 
-        label_param = @src[:label].delete('"').tr(' ', '+')
-        href = "#{@options[:gitlab_url]}/#{@src[:namespace]}/issues?label_name=#{label_param}"
+        href = "#{@options[:gitlab_url]}/#{namespace}/snippets/#{@src[:snippet]}"
 
         el = Kramdown::Element.new(:a, nil, { 'href' => href }, location: start_line_number)
-        add_text(@src[0], el)
+        add_text(reference_text, el)
         @tree.children << el
       end
     end

data/lib/gitlab_kramdown/parser.rb

@@ -10,6 +10,7 @@ module GitlabKramdown
     autoload :FencedBlockquote, 'gitlab_kramdown/parser/fenced_blockquote'
     autoload :FencedCodeblock, 'gitlab_kramdown/parser/fenced_codeblock'
     autoload :Header, 'gitlab_kramdown/parser/header'
+    autoload :Label, 'gitlab_kramdown/parser/label'
     autoload :Reference, 'gitlab_kramdown/parser/reference'
     autoload :Strikethrough, 'gitlab_kramdown/parser/strikethrough'
   end

data/lib/gitlab_kramdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitlabKramdown
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -14,6 +14,7 @@ module Kramdown
       include ::GitlabKramdown::Parser::FencedBlockquote
       include ::GitlabKramdown::Parser::FencedCodeblock
       include ::GitlabKramdown::Parser::Header
+      include ::GitlabKramdown::Parser::Label
       include ::GitlabKramdown::Parser::Reference
       include ::GitlabKramdown::Parser::Strikethrough
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Gabriel Mazetto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -197,6 +197,7 @@ files:
 - lib/gitlab_kramdown/parser/fenced_blockquote.rb
 - lib/gitlab_kramdown/parser/fenced_codeblock.rb
 - lib/gitlab_kramdown/parser/header.rb
+- lib/gitlab_kramdown/parser/label.rb
 - lib/gitlab_kramdown/parser/reference.rb
 - lib/gitlab_kramdown/parser/strikethrough.rb
 - lib/gitlab_kramdown/version.rb
@@ -209,7 +210,7 @@ metadata:
   source_code_uri: https://gitlab.com/gitlab-org/gitlab_kramdown
   changelog_uri: https://gitlab.com/gitlab-org/gitlab_kramdown/blob/main/CHANGELOG.md
   bug_tracker_uri: https://gitlab.com/gitlab-org/gitlab_kramdown/-/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.4
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -225,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: GitLab Flavored Kramdown
 test_files: []