gitlab_kramdown 0.5.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863ff5cdca8cd14c9de1619a1fcb4512ad12ae602a688097a4f3a03d85483d77
-  data.tar.gz: 4adb0e3732d0bf380c1e8b7afc0bc6ae4db90a39d51a6a81489d02025a5c9629
+  metadata.gz: 46edf71a2cbaa91e378788b9ff7b369c2fe864211cf1d6b8ba673b77a9a13bca
+  data.tar.gz: 9d9411975cb4f61ece5f8033db432a4f1cd6236c99c606aa4fc953654c941572
 SHA512:
-  metadata.gz: c8d9d12504b784b056dd2ef6e49bfb9664b454b1fefd6242c388a3e6ffc52bc18d0706bd08eb907b3a5759e8cf4ac84647e4a4ac3c55334d862b65042181f6b7
-  data.tar.gz: 131c9a44c743e52ddcb74684c2236155ad89c54b073b80b1887e4213a043c821a56fcc042b1e27eb69596ae54032e17be5a71474a8adf2ecc25a057c140fe452
+  metadata.gz: ee0f367f0d723917d0c5a96650c5a2a9e7e78cbf4c7da762e4f42a3ba563b77562e4cb020f3e67ff67671d345de8b93e046b338d9eb857e955ae230184c685d1
+  data.tar.gz: a302ab1dbc1cb14c1ca4e08087268ca144af2e1c00282ff13bd8ec80f83c96c25e1a3c4e829027fdc97758d67d5ace9c38b38043c80f54e0115d735cda5a6e73

data/CHANGELOG.md

@@ -0,0 +1,100 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.10.0] - 2020-08-27
+
+- Update Gem dependencies
+
+## [0.9.0] - 2019-10-17
+
+### Fixed
+- Fix very long IDs for headers that include links.
+
+### Added
+- Images should be clickable and linked to itself
+- Clickable images behavior is configurable
+
+### [0.8.0] - 2019-10-14
+
+### Changed
+- Revert "Fix very long IDs for headers that include links"
+
+### [0.7.0] - 2019-10-11
+
+### Added
+- Add support for PlantUML
+
+### Changed
+- Ruby 2.4 support is dropped.
+- Fix very long IDs for headers that include links.
+
+## [0.6.0] - 2019-05-07
+### Changed
+- URL Autolinks are now disabled by default (you can re-enable with `autolink: true` configuration param)
+
+### Added
+- Added support for rendering Mermaid when their JS is available
+
+## [0.5.0] - 2019-04-09
+### Added
+- Strikethrough support
+
+## [0.4.2] - 2018-11-21
+### Changed
+- URL autolinks will not execute inside `[]()` or `[]` blocks
+- Freezing `kramdown` version to allow only patchlevel changes
+
+## [0.4.1] - 2018-11-02
+### Added
+- Codebase now have a benchmark utility to compare with plain Kramdown
+
+### Changed
+- Many performance improvements on existing RegExp rules
+- Improve gemspec metadata and include only needed files on gem
+
+## [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`)
+
+### Changed
+- Fixed multiline blockquote delimiter
+- GitLab URL is not customizable with `gitlab_url: 'http://yourcustomgitlab.com'`
+
+## [0.2.0] - 2018-03-19
+### Added
+- Syntax highlighter uses ``` or ~~~
+
+### Changed
+- Requires Ruby 2.4
+- Requires rouge `~> 3.0`
+
+## [0.1.0] - 2018-03-17
+### Added
+- The initial version of the Gem
+- Special GitLab References
+- Multiline Blockquote
+
+[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,20 +1,21 @@
+The MIT License (MIT)
+
 Copyright (c) 2018-2019 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 in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -25,7 +25,8 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [Videos]                        | No           |
 | [Math]                          | No           |
 | [Colors]                        | No           |
-| [Mermaid]                       | No           |
+| [Mermaid]                       | **Yes**      |
+| [PlantUML]                       | **Yes**      |
 
 > **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists
   in Kramdown flavor.
@@ -36,6 +37,8 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | :------------------| :------------------: | -------------------------------------------- |
 | `gitlab_url`       | `https://gitlab.com` | GitLab instance URL to build reference links |
 | `linkable_headers` | true                 | Generate anchor tags with headers?           |
+| `autolink`         | false                | Converts URLs to HTML links (can be slow)    | 
+| `clickable_images` | true                 | Autolink images to themselves                | 
 
 ## Usage example
 
@@ -68,6 +71,11 @@ To have also syntax highlighting using the same engine GitLab use, you need to d
 Kramdown::Document.new(source, input: 'GitlabKramdown', syntax_highlighter: :rouge).to_html
 ```
 
+## Supported and tested Ruby versions:
+
+- Ruby 2.5
+- Ruby 2.6
+
 ## Contributing to gitlab_kramdown
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
@@ -101,3 +109,4 @@ further details.
 [Math]: https://docs.gitlab.com/ee/user/markdown.html#math
 [Colors]: https://docs.gitlab.com/ee/user/markdown.html#colors
 [Mermaid]: https://docs.gitlab.com/ee/user/markdown.html#mermaid
+[PlantUML]: https://docs.gitlab.com/ee/administration/integration/plantuml.html#creating-diagrams

data/lib/gitlab_kramdown.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'kramdown/parser'
+require 'kramdown/converter'
 
 # GitLab Kramdown implements Markdown flavored extensions on top of Kramdown
 #
@@ -17,7 +18,15 @@ require 'kramdown/parser'
 module GitlabKramdown
   autoload :VERSION, 'gitlab_kramdown/version'
   autoload :Parser, 'gitlab_kramdown/parser'
+
+  # Gitlab Kramdown custom Converters
+  module Converter
+    autoload :GitlabHtml, 'gitlab_kramdown/converter/gitlab_html'
+  end
 end
 
 # Autoload extensions
 Kramdown::Parser.autoload :GitlabKramdown, 'kramdown/parser/gitlab_kramdown'
+
+# Custom HTML extensions
+Kramdown::Converter::Html.prepend(GitlabKramdown::Converter::GitlabHtml)

data/lib/gitlab_kramdown/converter/gitlab_html.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'kramdown/converter/html'
+require 'nokogiri'
+require 'asciidoctor-plantuml'
+
+module GitlabKramdown
+  module Converter
+    # Converts a Kramdown::Document to HTML.
+    #
+    # This includes GitLab custom elements from GitLab Flavored Markdown syntax
+    module GitlabHtml
+      # Initializes a GitLab custom HTML converter with a given document
+      #
+      # It accepts all existing options for HTML converter with our custom ones:
+      #
+      # * +clickable_images+ (default: true) - whether images will have a link to itself
+      #
+      # @param [Kramdown::Document] root
+      # @param [Hash] options
+      def initialize(root, options)
+        super(root, options)
+
+        @clickable_images = options[:clickable_images] != false
+      end
+
+      # Codeblock is customized in order to implement a different output to Mermaid
+      #
+      # Mermaid requires `<div class="mermaid"></div>` surrounding the content in order
+      # to trigger the unobtrusive JS.
+      def convert_codeblock(element, opts)
+        if element.options[:lang] == 'mermaid'
+          %(<div class="mermaid">#{element.value}</div>\n)
+        elsif element.options[:lang] == 'plantuml'
+          plantuml_setup
+
+          img_tag = Nokogiri::HTML::DocumentFragment.parse(
+            Asciidoctor::PlantUml::Processor.plantuml_content(element.value, {})
+          )
+
+          %(#{img_tag}\n)
+        else
+          super
+        end
+      end
+
+      def plantuml_setup
+        Asciidoctor::PlantUml.configure do |conf|
+          conf.url = 'https://plantuml.gitlab-static.net'
+          conf.png_enable = true
+          conf.svg_enable = false
+          conf.txt_enable = false
+        end
+      end
+
+      # Images can have a link to themselves when configuration allows
+      #
+      # We don't autolink when image is already linked to something-else
+      #
+      # @param [Kramdown::Element] element
+      # @param [Integer] _indent
+      def convert_img(element, _indent)
+        return super unless @clickable_images
+        return super if @stack.last.type == :a
+
+        href = element.attr['src']
+
+        %(<a href="#{href}" target="_blank" rel="noopener noreferrer">#{super}</a>)
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser/header.rb

@@ -73,9 +73,11 @@ module GitlabKramdown
       end
 
       NON_WORD_RE = /[^\p{Word}\- \t]/.freeze
+      MARKDOWN_LINK_TEXT = /\[(?<link_text>[^\]]+)\]\((?<link_url>[^\)]+)\)/.freeze
 
       def generate_header_id(text)
         result = text.downcase
+        result.gsub!(MARKDOWN_LINK_TEXT) { |s| MARKDOWN_LINK_TEXT.match(s)[:link_text].gsub(NON_WORD_RE, '') }
         result.gsub!(NON_WORD_RE, '')
         result.tr!(" \t", '-')
         @id_counter[result] += 1

data/lib/gitlab_kramdown/version.rb

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

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -21,11 +21,13 @@ module Kramdown
         super
 
         @options[:gitlab_url] ||= 'https://gitlab.com'
+        @options[:autolink] = false if @options[:autolink].nil?
         @options[:linkable_headers] = true if @options[:linkable_headers].nil?
         @id_counter = Hash.new(-1)
 
+        prepend_span_parsers(:gitlab_autolink) if @options[:autolink]
         prepend_span_parsers(:escape_chars_gitlab, :commit_diff, :commit, :user_group_mention,
-                             :issue, :merge_request, :snippet, :label, :gitlab_autolink, :strikethrough_gitlab)
+                             :issue, :merge_request, :snippet, :label, :strikethrough_gitlab)
         prepend_block_parsers(:fenced_blockquote)
         replace_block_parser!(:codeblock_fenced, :codeblock_fenced_gitlab)
         replace_block_parser!(:atx_header, :atx_gitlab_header)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,70 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-plantuml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -152,16 +180,17 @@ dependencies:
         version: '2.7'
 description: GitLab Flavored Markdown extensions on top of Kramdown markup. Tries
   to be as close as possible to existing extensions.
-email: brodock@gmail.com
+email:
+- brodock@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/gitlab_kramdown.rb
+- lib/gitlab_kramdown/converter/gitlab_html.rb
 - lib/gitlab_kramdown/parser.rb
 - lib/gitlab_kramdown/parser/autolink.rb
 - lib/gitlab_kramdown/parser/escape.rb
@@ -172,23 +201,23 @@ files:
 - lib/gitlab_kramdown/parser/strikethrough.rb
 - lib/gitlab_kramdown/version.rb
 - lib/kramdown/parser/gitlab_kramdown.rb
-homepage: http://gitlab.com/gitlab-org/gitlab_kramdown
+homepage: https://gitlab.com/gitlab-org/gitlab_kramdown
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://gitlab.com/gitlab-org/gitlab_kramdown/issues
-  changelog_uri: http://gitlab.com/gitlab-org/gitlab_kramdown/blob/master/CHANGELOG.md
-  homepage_uri: http://gitlab.com/gitlab-org/gitlab_kramdown
-  source_code_uri: http://gitlab.com/gitlab-org/gitlab_kramdown
+  homepage_uri: https://gitlab.com/gitlab-org/gitlab_kramdown
+  source_code_uri: https://gitlab.com/gitlab-org/gitlab_kramdown
+  changelog_uri: https://gitlab.com/gitlab-org/gitlab_kramdown/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://gitlab.com/gitlab-org/gitlab_kramdown/-/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="