gitlab_kramdown 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f56f5ad5ed710fefd24289c68ec7fe621f67261875def66fc7c4588a1a3f4930
-  data.tar.gz: 023f11be46858b9fff9cbf7aaf880629b665155aeb95f6f8804ff3fab19fd992
+  metadata.gz: 863ff5cdca8cd14c9de1619a1fcb4512ad12ae602a688097a4f3a03d85483d77
+  data.tar.gz: 4adb0e3732d0bf380c1e8b7afc0bc6ae4db90a39d51a6a81489d02025a5c9629
 SHA512:
-  metadata.gz: 41affa513909efce3c3aed46a185d0e2220dd96a64a54a33d0862aabf71fd21a46cc8fa3992966284e31a8deb6e0c0e38131427f3e0ab96d3e31d50f6ee94222
-  data.tar.gz: 2ad36ecf7f2b4003f1c7fbec5f99208be2e5098de42ad4bd129ff38004eaca9d334e1ac94eae14ca3dcbe84cfa39b4090227524c308d0b72c9492c0a82708c60
+  metadata.gz: c8d9d12504b784b056dd2ef6e49bfb9664b454b1fefd6242c388a3e6ffc52bc18d0706bd08eb907b3a5759e8cf4ac84647e4a4ac3c55334d862b65042181f6b7
+  data.tar.gz: 131c9a44c743e52ddcb74684c2236155ad89c54b073b80b1887e4213a043c821a56fcc042b1e27eb69596ae54032e17be5a71474a8adf2ecc25a057c140fe452

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Gabriel Mazetto
+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

data/README.md

@@ -1,9 +1,9 @@
 # GitLab Kramdown
 
-This is an official gem that implements [GitLab flavored Markdown] extensions on top of [Kramdown]. 
+This is an official gem that implements [GitLab flavored Markdown] extensions on top of [Kramdown].
 
-> **Note**: This is not the same code that runs on GitLab. The [GitLab flavored Markdown] runs on top of 
-CommonMark with extensions implemented inside the Rails application. 
+> **Note**: This is not the same code that runs on GitLab. The [GitLab flavored Markdown] runs on top of
+CommonMark with extensions implemented inside the Rails application.
 
 ## GitLab Flavored Markdown extensions support
 
@@ -17,6 +17,7 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [URL auto-linking]              | **Yes**      |
 | [Multiline Blockquote]          | **Yes**      |
 | [Code and Syntax Highlighting]  | **Yes**      |
+| [Strikethrough]                 | **Yes**      |
 | [Inline Diff]                   | No           |
 | [Emoji]                         | No           |
 | [Special GitLab references]     | **Yes**      |
@@ -26,16 +27,16 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [Colors]                        | No           |
 | [Mermaid]                       | No           |
 
-> **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists 
+> **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists
   in Kramdown flavor.
- 
+
 ## Configuration parameters
 
 | Parameter          | Default              | Description                                  |
 | :------------------| :------------------: | -------------------------------------------- |
 | `gitlab_url`       | `https://gitlab.com` | GitLab instance URL to build reference links |
-| `linkable_headers` | true                 | Generate anchor tags with headers?           | 
-  
+| `linkable_headers` | true                 | Generate anchor tags with headers?           |
+
 ## Usage example
 
 To use this gem you're also required to install [Kramdown]. This gem will hook into Kramdown and provide custom
@@ -54,8 +55,8 @@ We support custom extensions like:
 This is a multiline
 Blockquote
 
-Using `>>>` as delimiter 
->>> 
+Using `>>>` as delimiter
+>>>
 EOF
 
 Kramdown::Document.new(source, input: 'GitlabKramdown').to_html
@@ -75,12 +76,12 @@ Kramdown::Document.new(source, input: 'GitlabKramdown', syntax_highlighter: :rou
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, 
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version,
   or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ## Copyright
 
-Copyright (c) 2018 Gabriel Mazetto. See LICENSE.txt for
+Copyright (c) 2018-2019 Gabriel Mazetto. See LICENSE.txt for
 further details.
 
 [GitLab flavored Markdown]: https://docs.gitlab.com/ee/user/markdown.html
@@ -91,6 +92,7 @@ further details.
 [URL auto-linking]: https://docs.gitlab.com/ee/user/markdown.html#url-auto-linking
 [Multiline Blockquote]: https://docs.gitlab.com/ee/user/markdown.html#multiline-blockquote
 [Code and Syntax Highlighting]: https://docs.gitlab.com/ee/user/markdown.html#code-and-syntax-highlighting
+[Strikethrough]: https://docs.gitlab.com/ee/user/markdown.html#emphasis
 [Inline Diff]: https://docs.gitlab.com/ee/user/markdown.html#inline-diff
 [Emoji]: https://docs.gitlab.com/ee/user/markdown.html#emoji
 [Special GitLab references]: https://docs.gitlab.com/ee/user/markdown.html#special-gitlab-references

data/lib/gitlab_kramdown/parser.rb

@@ -5,10 +5,12 @@ module GitlabKramdown
   #
   # All GitLab extensions to Kramdown are implemented as a Parser in this module
   module Parser
+    autoload :Autolink, 'gitlab_kramdown/parser/autolink'
+    autoload :Escape, 'gitlab_kramdown/parser/escape'
     autoload :FencedBlockquote, 'gitlab_kramdown/parser/fenced_blockquote'
     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'
+    autoload :Strikethrough, 'gitlab_kramdown/parser/strikethrough'
   end
 end

data/lib/gitlab_kramdown/parser/escape.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # Escape chars support
+    #
+    # This is a standalone parser because making it so is an optimization
+    #
+    # Based on Kramdown GFM implementation
+    module Escape
+      ESCAPED_CHARS_GFM = /\\([\\.*_+`<>()\[\]{}#!:\|"'\$=\-~])/.freeze
+
+      def self.included(klass)
+        klass.define_parser(:escape_chars_gitlab, ESCAPED_CHARS_GFM, '\\\\', :parse_escaped_chars)
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser/fenced_codeblock.rb

@@ -11,6 +11,8 @@ module GitlabKramdown
     #
     # For maximum compatibility with GitLab, use `:rouge` as your highlighter.
     #
+    # Based on Kramdown GFM implementation
+    #
     # @see https://docs.gitlab.com/ee/user/markdown.html#code-and-syntax-highlighting
     module FencedCodeblock
       FENCED_CODEBLOCK_START = /^[ ]{0,3}[~`]{3,}/.freeze

data/lib/gitlab_kramdown/parser/strikethrough.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # Strikethrough
+    #
+    # This parser implements strikethrough markup based on GFM
+    # used as-is in GitLab Flavored Markdown
+    #
+    # Based on Kramdown GFM implementation
+    #
+    # @see https://docs.gitlab.com/ee/user/markdown.html#emphasis
+    module Strikethrough
+      STRIKETHROUGH_DELIM = /~~/.freeze
+      STRIKETHROUGH_MATCH = %r{
+        (?<re>
+          #{STRIKETHROUGH_DELIM} # start with ~~
+          (?!\s|~)               # not followed by ~ or space (negative lookahead)
+          (?:\g<re>|.*?)*        # recursive <re> or lazy match anything
+          (?<!\s|~)              # something different than space and ~ (negative lookbehind)
+          #{STRIKETHROUGH_DELIM} # end with ~~
+        )
+      }x.freeze
+
+      def self.included(klass)
+        klass.define_parser(:strikethrough_gitlab, STRIKETHROUGH_MATCH, '~~')
+      end
+
+      def parse_strikethrough_gitlab
+        line_number = @src.current_line_number
+
+        @src.pos += @src.matched_size
+        el = Kramdown::Element.new(:html_element, 'del', {}, category: :span, line: line_number)
+        @tree.children << el
+
+        env = save_env
+        reset_env(src: Kramdown::Utils::StringScanner.new(@src.matched[2..-3], line_number), text_type: :text)
+        parse_spans(el)
+        restore_env(env)
+
+        el
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/version.rb

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

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -9,11 +9,13 @@ module Kramdown
     # This is not 100% compatible with GFM used in GitLab application as it
     # includes extensions available only in kramdown.
     class GitlabKramdown < Kramdown::Parser::Kramdown
+      include ::GitlabKramdown::Parser::Autolink
+      include ::GitlabKramdown::Parser::Escape
       include ::GitlabKramdown::Parser::FencedBlockquote
       include ::GitlabKramdown::Parser::FencedCodeblock
       include ::GitlabKramdown::Parser::Header
       include ::GitlabKramdown::Parser::Reference
-      include ::GitlabKramdown::Parser::Autolink
+      include ::GitlabKramdown::Parser::Strikethrough
 
       def initialize(source, options)
         super
@@ -22,8 +24,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, :gitlab_autolink)
+        prepend_span_parsers(:escape_chars_gitlab, :commit_diff, :commit, :user_group_mention,
+                             :issue, :merge_request, :snippet, :label, :gitlab_autolink, :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.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -164,10 +164,12 @@ files:
 - lib/gitlab_kramdown.rb
 - lib/gitlab_kramdown/parser.rb
 - lib/gitlab_kramdown/parser/autolink.rb
+- lib/gitlab_kramdown/parser/escape.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/gitlab_kramdown/parser/strikethrough.rb
 - lib/gitlab_kramdown/version.rb
 - lib/kramdown/parser/gitlab_kramdown.rb
 homepage: http://gitlab.com/gitlab-org/gitlab_kramdown
@@ -193,8 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: GitLab Flavored Kramdown