gitlab_kramdown 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c302bd8a4d80884d60ae30af2e340bd5eeeafd2
-  data.tar.gz: ac9dd5677dde90928873a3b7fad43b9fa1472f82
+  metadata.gz: b1300ec014cee9ac392ba0934415585953a90c1d
+  data.tar.gz: 252c205835324990971e33f54a34e59bab01203e
 SHA512:
-  metadata.gz: a1b66031f521c04b81ae3cd49a868a326b46784a56b12962870b2ad3c7d0600c75c0c53d52ec5d274db433e5f075b6f48ec4de926f329b0aa573d56a2f4abbfe
-  data.tar.gz: d987318ef35170813d4d90a4a44583d9865a079e84d248f9b3067b7a6f1406af0a4c3c772dc626d4d3eb67d1ec1ff509351a9ccee540b998d3e46e3915455958
+  metadata.gz: e87efac88a9b5c980a67a8c6f74da59cf4b0bfa07d95d0b148ccc6db536380bc10f8a5a40c9bd3de860fa35a20aa850b7a0f9ed003a2ee39cd254971f9bc794e
+  data.tar.gz: aea0b96c06aaeba06ce712eb984b8ceb5eb754333ed321aef5ff1ef1c6372be97b406d5257a616e32be9adc6a29eb66207ad669c2e5f2b78b9cda1785a3cfde5

data/.rubocop.yml

@@ -6,14 +6,23 @@ AllCops:
     - '*.gemspec'
 Layout/IndentArray:
   EnforcedStyle: consistent
+Lint/InterpolationCheck:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/**'
 Metrics/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 30
 Style/FrozenStringLiteralComment:
   Exclude:
     - 'spec/**/**'
 Style/RegexpLiteral:
   EnforcedStyle: mixed
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
+Style/ParallelAssignment:
   Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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 ~~~

data/README.md

@@ -10,6 +10,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           |
 | [Multiline Blockquote]          | **Yes**      |
 | [Code and Syntax Highlighting]  | **Yes**      |
@@ -23,7 +24,14 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [Mermaid]                       | No           |
 
 > **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists 
-  in Kramdown flavor. 
+  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?           | 
   
 ## Usage example
 
@@ -76,6 +84,7 @@ further details.
 [Kramdown]: https://kramdown.gettalong.org/
 [Newlines]: https://docs.gitlab.com/ee/user/markdown.html#newlines
 [Multiple underscores in words]: https://docs.gitlab.com/ee/user/markdown.html#multiple-underscores-in-words
+[Headers with Anchors]: https://docs.gitlab.com/ee/user/markdown.html#headers
 [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

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.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.2.0 ruby lib
+# stub: gitlab_kramdown 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gitlab_kramdown".freeze
-  s.version = "0.2.0"
+  s.version = "0.3.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-19"
+  s.date = "2018-03-23"
   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 = [
@@ -35,10 +35,14 @@ Gem::Specification.new do |s|
     "lib/gitlab_kramdown/parser.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/code_highlight.html",
     "spec/fixtures/code_highlight.text",
+    "spec/fixtures/header.html",
+    "spec/fixtures/header.linkable_headers.html",
+    "spec/fixtures/header.text",
     "spec/fixtures/multi_blockquote.html",
     "spec/fixtures/multi_blockquote.text",
     "spec/fixtures/references.html",

data/lib/gitlab_kramdown/parser/fenced_blockquote.rb

@@ -11,13 +11,14 @@ module GitlabKramdown
       FENCED_BLOCKQUOTE_START = />{3}/x
 
       FENCED_BLOCKQUOTE_MATCH = %r{
-        ^(?<delimiter>>{3})       # line must start with >>>
-        \s*           # any amount of trailling whitespace
-        \n            # followed by a linebreak
-        (?<content>[\S\s]+)         # at least one non whitespace chracter
+        ^(?<delimiter>>{3})   # line must start with >>>
+        \s*                   # any amount of trailling whitespace
+        \n                    # followed by a linebreak
+        (?<content>[\S\s]+)   # at least one non whitespace chracter
         \n
-        \k<delimiter>           # same delimiter used to open the block
-        \s*                     # any amount of trailling whitespace
+        \k<delimiter>         # same delimiter used to open the block
+        [ \t]*                # any amount of trailling whitespace
+        \s
       }xm
 
       def self.included(klass)

data/lib/gitlab_kramdown/parser/header.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # Header with embedded link anchor
+    #
+    # This parser implements header with additional a tag linking to own anchor
+    # For best results, some CSS styling can be used to emulate :hover behavior
+    #
+    # @see https://docs.gitlab.com/ee/user/markdown.html#headers
+    module Header
+      HEADER_ID = /(?:[ \t]+\{#([A-Za-z][\w:-]*)\})?/
+      SETEXT_HEADER_START = /^(#{Kramdown::Parser::Kramdown::OPT_SPACE}[^ \t].*?)#{HEADER_ID}[ \t]*?\n(-|=)+\s*?\n/
+
+      def self.included(klass)
+        klass.define_parser(:setext_gitlab_header, SETEXT_HEADER_START)
+        klass.define_parser(:atx_gitlab_header, ATX_HEADER_START)
+      end
+
+      # Parse the Setext header at the current location.
+      def parse_setext_gitlab_header
+        start_line_number = @src.current_line_number
+        @src.pos += @src.matched_size
+        text, id, level = @src[1], @src[2], @src[3]
+        text.strip!
+
+        el = new_block_el(:header, nil, nil, level: (level == '-' ? 2 : 1), raw_text: text, location: start_line_number)
+        add_text(text, el)
+        el.attr['id'] = id ? id : generate_header_id(text)
+
+        if @options[:linkable_headers]
+          el.children << Kramdown::Element.new(:a, nil, {
+                                                 'href' => "##{el.attr['id']}",
+                                                 'title' => 'Permalink',
+                                                 'class' => 'anchor'
+                                               }, location: start_line_number)
+        end
+
+        @tree.children << el
+        true
+      end
+
+      ATX_HEADER_START = /^\#{1,6}/
+      ATX_HEADER_MATCH = /^(\#{1,6})(.+?(?:\\#)?)\s*?#*#{HEADER_ID}\s*?\n/
+
+      # Parse the Atx header at the current location.
+      def parse_atx_gitlab_header
+        start_line_number = @src.current_line_number
+        @src.check(ATX_HEADER_MATCH)
+        level, text, id = @src[1], @src[2].to_s.strip, @src[3]
+        return false if text.empty?
+
+        @src.pos += @src.matched_size
+
+        el = new_block_el(:header, nil, nil, level: level.length, raw_text: text, location: start_line_number)
+        add_text(text, el)
+        el.attr['id'] = id ? id : generate_header_id(text)
+
+        if @options[:linkable_headers]
+          el.children << Kramdown::Element.new(:a, nil, {
+                                                 'href' => "##{el.attr['id']}",
+                                                 'title' => 'Permalink',
+                                                 'class' => 'anchor'
+                                               }, location: start_line_number)
+        end
+
+        @tree.children << el
+        true
+      end
+
+      NON_WORD_RE = /[^\p{Word}\- \t]/
+
+      def generate_header_id(text)
+        result = text.downcase
+        result.gsub!(NON_WORD_RE, '')
+        result.tr!(" \t", '-')
+        @id_counter[result] += 1
+        result << (@id_counter[result].positive? ? "-#{@id_counter[result]}" : '')
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser.rb

@@ -7,6 +7,7 @@ module GitlabKramdown
   module Parser
     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'
   end
 end

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -11,15 +11,21 @@ module Kramdown
     class GitlabKramdown < Kramdown::Parser::Kramdown
       include ::GitlabKramdown::Parser::FencedBlockquote
       include ::GitlabKramdown::Parser::FencedCodeblock
+      include ::GitlabKramdown::Parser::Header
       include ::GitlabKramdown::Parser::Reference
 
       def initialize(source, options)
         super
 
-        @options[:gitlab_url] = 'https://gitlab.com'
+        @options[:gitlab_url] ||= 'https://gitlab.com'
+        @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_block_parsers(:fenced_blockquote)
         replace_block_parser!(:codeblock_fenced, :codeblock_fenced_gitlab)
+        replace_block_parser!(:atx_header, :atx_gitlab_header)
+        replace_block_parser!(:setext_header, :setext_gitlab_header)
       end
 
       private

data/spec/fixtures/header.html

@@ -0,0 +1,12 @@
+<h1 id="h1">H1</h1>
+<h2 id="h2">H2</h2>
+<h3 id="h3">H3</h3>
+<h4 id="h4">H4</h4>
+<h5 id="h5">H5</h5>
+<h6 id="h6">H6</h6>
+
+<p>Alternatively, for H1 and H2, an underline-ish style:</p>
+
+<h1 id="alt-h1">Alt-H1</h1>
+
+<h2 id="alt-h2">Alt-H2</h2>

data/spec/fixtures/header.linkable_headers.html

@@ -0,0 +1,12 @@
+<h1 id="h1">H1<a href="#h1" title="Permalink" class="anchor"></a></h1>
+<h2 id="h2">H2<a href="#h2" title="Permalink" class="anchor"></a></h2>
+<h3 id="h3">H3<a href="#h3" title="Permalink" class="anchor"></a></h3>
+<h4 id="h4">H4<a href="#h4" title="Permalink" class="anchor"></a></h4>
+<h5 id="h5">H5<a href="#h5" title="Permalink" class="anchor"></a></h5>
+<h6 id="h6">H6<a href="#h6" title="Permalink" class="anchor"></a></h6>
+
+<p>Alternatively, for H1 and H2, an underline-ish style:</p>
+
+<h1 id="alt-h1">Alt-H1<a href="#alt-h1" title="Permalink" class="anchor"></a></h1>
+
+<h2 id="alt-h2">Alt-H2<a href="#alt-h2" title="Permalink" class="anchor"></a></h2>

data/spec/fixtures/header.text

@@ -0,0 +1,14 @@
+# H1
+## H2
+### H3
+#### H4
+##### H5
+###### H6
+
+Alternatively, for H1 and H2, an underline-ish style:
+
+Alt-H1
+======
+
+Alt-H2
+------

data/spec/fixtures/multi_blockquote.html

@@ -9,3 +9,5 @@
 
   <p>you can quote that without having to manually prepend <code>&gt;</code> to every line!</p>
 </blockquote>
+
+<h2 id="title-here">Title here</h2>

data/spec/fixtures/multi_blockquote.text

@@ -9,3 +9,5 @@ multiple lines,
 
 you can quote that without having to manually prepend `>` to every line!
 >>>
+
+## Title here

data/spec/integration/parser_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 context 'GitLab Kramdown Integration tests' do
   let(:options) do
-    { input: 'GitlabKramdown' }
+    { input: 'GitlabKramdown', linkable_headers: false }
   end
 
   context 'HTML render' do
@@ -15,5 +15,22 @@ context 'GitLab Kramdown Integration tests' do
         expect(parser.to_html).to eq(target)
       end
     end
+
+    context 'linkable_headers enabled' do
+      let(:options) do
+        { input: 'GitlabKramdown', linkable_headers: true }
+      end
+
+      it 'Renders header as headers.linkable_headers.html' do
+        text_file = File.join(Fixtures.fixtures_path, 'header.text')
+        html_file = File.join(Fixtures.fixtures_path, 'header.linkable_headers.html')
+
+        source = File.read(text_file)
+        target = File.read(html_file)
+        parser = Kramdown::Document.new(source, options)
+
+        expect(parser.to_html).to eq(target)
+      end
+    end
   end
 end

data/spec/support/fixtures.rb

@@ -2,14 +2,14 @@
 
 module Fixtures
   def self.text_files
-    Dir[File.join(folder, '**/*.text')]
+    Dir[File.join(fixtures_path, '**/*.text')]
   end
 
   def self.html_file(text_file)
     text_file.sub('.text', '.html')
   end
 
-  def self.folder
+  def self.fixtures_path
     File.expand_path(File.join(File.dirname(__FILE__), '../fixtures'))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -147,10 +147,14 @@ files:
 - lib/gitlab_kramdown/parser.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/code_highlight.html
 - spec/fixtures/code_highlight.text
+- spec/fixtures/header.html
+- spec/fixtures/header.linkable_headers.html
+- spec/fixtures/header.text
 - spec/fixtures/multi_blockquote.html
 - spec/fixtures/multi_blockquote.text
 - spec/fixtures/references.html