gitlab_kramdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8111e5ed2d1d7557b1e1de41fe5f5d45d9bb9225
-  data.tar.gz: 76f39ec6a1a591acdd213ff2a2e3844840b61b26
+  metadata.gz: 0c302bd8a4d80884d60ae30af2e340bd5eeeafd2
+  data.tar.gz: ac9dd5677dde90928873a3b7fad43b9fa1472f82
 SHA512:
-  metadata.gz: '0938e8bd16e0a6f6886ef7031074665fdd8e01d044162d1ab861c7aa4899c8a34d803022a9e150f4bd5db0de2aea2310e97c1b8c400e6bf4590ed776c6467bc0'
-  data.tar.gz: b95d7735ae88b1847ca218ff2616ace5a0a20eb204b4aa25a0391daae5cdc8157254acde364979ac5c6892fd26d0941403bd4ff916a8359d9de2ae951842c376
+  metadata.gz: a1b66031f521c04b81ae3cd49a868a326b46784a56b12962870b2ad3c7d0600c75c0c53d52ec5d274db433e5f075b6f48ec4de926f329b0aa573d56a2f4abbfe
+  data.tar.gz: d987318ef35170813d4d90a4a44583d9865a079e84d248f9b3067b7a6f1406af0a4c3c772dc626d4d3eb67d1ec1ff509351a9ccee540b998d3e46e3915455958

data/.gitlab-ci.yml

@@ -1,9 +1,10 @@
 image: "ruby:2.4"
 
 # Cache gems in between builds
-cache:
+cache: &cache
   paths:
     - vendor/ruby
+  key: 'ruby2.4'
 
 before_script:
   - ruby -v                                   # Print out ruby version for debugging
@@ -14,6 +15,14 @@ rubocop:
   script:
   - rubocop
 
-rspec:
+rspec ruby2.4:
+  script:
+  - rake spec
+
+rspec ruby2.5:
+  image: "ruby:2.5"
+  cache:
+    <<: *cache
+    key: 'ruby2.5'
   script:
   - rake spec

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - '**/Rakefile'
     - 'Gemfile'
     - 'vendor/**/**'
+    - '*.gemspec'
 Layout/IndentArray:
   EnforcedStyle: consistent
 Metrics/LineLength:

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# 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.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

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 gem 'kramdown', '~> 1.16'
+gem 'rouge', '~> 3.0'
 
 group :development do
   gem 'rdoc', '~> 3.12'

data/Gemfile.lock

@@ -55,6 +55,7 @@ GEM
     rake (12.3.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    rouge (3.1.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -93,6 +94,7 @@ DEPENDENCIES
   juwelier (~> 2.1.0)
   kramdown (~> 1.16)
   rdoc (~> 3.12)
+  rouge (~> 3.0)
   rspec
   rubocop
   simplecov

data/README.md

@@ -2,6 +2,60 @@
 
 This is an unofficial gem that implements [GitLab flavored Markdown] extensions on top of [Kramdown]
 
+## GitLab Flavored Markdown extensions support
+
+This is a list of GitLab Flavored Markdown (GFM) extensions and their status of support on this gem:
+
+| GFM Extensions                  | Implemented? |
+|---------------------------------|--------------|
+| [Newlines]                      | No           |
+| [Multiple underscores in words] | _Kramdown_   |
+| [URL auto-linking]              | No           |
+| [Multiline Blockquote]          | **Yes**      |
+| [Code and Syntax Highlighting]  | **Yes**      |
+| [Inline Diff]                   | No           |
+| [Emoji]                         | No           |
+| [Special GitLab references]     | **Yes**      |
+| [Task Lists]                    | No           |
+| [Videos]                        | No           |
+| [Math]                          | No           |
+| [Colors]                        | No           |
+| [Mermaid]                       | No           |
+
+> **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists 
+  in Kramdown flavor. 
+  
+## Usage example
+
+To use this gem you're also required to install [Kramdown]. This gem will hook into Kramdown and provide custom
+parser.
+
+```ruby
+require 'kramdown'
+require 'gitlab_kramdown'
+
+source = <<-EOF
+# GFM example
+
+We support custom extensions like:
+
+>>>
+This is a multiline
+Blockquote
+
+Using `>>>` as delimiter 
+>>> 
+EOF
+
+Kramdown::Document.new(source, input: 'GitlabKramdown').to_html
+```
+
+To have also syntax highlighting using the same engine GitLab use, you need to define the highlighter as `:rouge`:
+
+```ruby
+Kramdown::Document.new(source, input: 'GitlabKramdown', syntax_highlighter: :rouge).to_html
+```
+
 ## 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.
@@ -10,7 +64,8 @@ This is an unofficial gem that implements [GitLab flavored Markdown] extensions
 * 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, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* 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
 
@@ -19,3 +74,16 @@ further details.
 
 [GitLab flavored Markdown]: https://docs.gitlab.com/ee/user/markdown.html
 [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
+[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
+[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
+[Task Lists]: https://docs.gitlab.com/ee/user/markdown.html#task-lists
+[Videos]: https://docs.gitlab.com/ee/user/markdown.html#videos
+[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

data/Rakefile

@@ -18,6 +18,7 @@ Juwelier::Tasks.new do |gem|
   gem.description = %Q{GitLab Flavored Markdown extensions on top of Kramdown markup. Tries to be as close as possible to existing extensions.}
   gem.email = "brodock@gmail.com"
   gem.authors = ["Gabriel Mazetto"]
+  gem.required_ruby_version = '~> 2.4'
 
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.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.1.0 ruby lib
+# stub: gitlab_kramdown 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gitlab_kramdown".freeze
-  s.version = "0.1.0"
+  s.version = "0.2.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-17"
+  s.date = "2018-03-19"
   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 = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     ".gitlab-ci.yml",
     ".rubocop.yml",
     ".ruby-version",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -33,8 +34,11 @@ Gem::Specification.new do |s|
     "lib/gitlab_kramdown.rb",
     "lib/gitlab_kramdown/parser.rb",
     "lib/gitlab_kramdown/parser/fenced_blockquote.rb",
+    "lib/gitlab_kramdown/parser/fenced_codeblock.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/multi_blockquote.html",
     "spec/fixtures/multi_blockquote.text",
     "spec/fixtures/references.html",
@@ -45,6 +49,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://gitlab.com/brodock/gitlab_kramdown".freeze
   s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new("~> 2.4".freeze)
   s.rubygems_version = "2.6.14".freeze
   s.summary = "GitLab Flavored Kramdown".freeze
 
@@ -53,6 +58,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<kramdown>.freeze, ["~> 1.16"])
+      s.add_runtime_dependency(%q<rouge>.freeze, ["~> 3.0"])
       s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
@@ -61,6 +67,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
     else
       s.add_dependency(%q<kramdown>.freeze, ["~> 1.16"])
+      s.add_dependency(%q<rouge>.freeze, ["~> 3.0"])
       s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
       s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
@@ -70,6 +77,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<kramdown>.freeze, ["~> 1.16"])
+    s.add_dependency(%q<rouge>.freeze, ["~> 3.0"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
     s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])

data/lib/gitlab_kramdown/parser/fenced_codeblock.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GitlabKramdown
+  module Parser
+    # Fenced Codeblock
+    #
+    # This parser implements codeblocks fenced by ``` or ~~~
+    #
+    # With a codeblock you can pass the language after the initial fenced separator
+    # and use one of Kramdowns syntax highlighters
+    #
+    # For maximum compatibility with GitLab, use `:rouge` as your highlighter.
+    #
+    # @see https://docs.gitlab.com/ee/user/markdown.html#code-and-syntax-highlighting
+    module FencedCodeblock
+      FENCED_CODEBLOCK_START = /^[ ]{0,3}[~`]{3,}/
+      FENCED_CODEBLOCK_MATCH = /^[ ]{0,3}(([~`]){3,})\s*?((\S+?)(?:\?\S*)?)?\s*?\n(.*?)^[ ]{0,3}\1\2*\s*?\n/m
+
+      def self.included(klass)
+        klass.define_parser(:codeblock_fenced_gitlab, FENCED_CODEBLOCK_START, nil, 'parse_codeblock_fenced')
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/parser.rb

@@ -6,6 +6,7 @@ module GitlabKramdown
   # All GitLab extensions to Kramdown are implemented as a Parser in this module
   module Parser
     autoload :FencedBlockquote, 'gitlab_kramdown/parser/fenced_blockquote'
+    autoload :FencedCodeblock, 'gitlab_kramdown/parser/fenced_codeblock'
     autoload :Reference, 'gitlab_kramdown/parser/reference'
   end
 end

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -9,16 +9,35 @@ 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::FencedBlockquote
+      include ::GitlabKramdown::Parser::FencedCodeblock
+      include ::GitlabKramdown::Parser::Reference
+
       def initialize(source, options)
         super
 
         @options[:gitlab_url] = 'https://gitlab.com'
-        @span_parsers.unshift(:commit_diff, :commit, :user_group_mention, :issue, :merge_request, :snippet, :label)
-        @block_parsers.unshift(:fenced_blockquote)
+        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)
       end
 
-      include ::GitlabKramdown::Parser::FencedBlockquote
-      include ::GitlabKramdown::Parser::Reference
+      private
+
+      def replace_block_parser!(original, new)
+        index = @block_parsers.index(original)
+
+        return false unless index
+        @block_parsers[index] = new
+      end
+
+      def prepend_span_parsers(*parsers)
+        @span_parsers.unshift(*parsers)
+      end
+
+      def prepend_block_parsers(*parsers)
+        @block_parsers.unshift(*parsers)
+      end
     end
   end
 end

data/spec/fixtures/code_highlight.html

@@ -0,0 +1,18 @@
+<p>This is a code block using 4 spaces syntax:
+    class Something
+      def method(param)
+      end
+    end</p>
+
+<p>This is a code block using 3-backticks ```:</p>
+
+<pre><code>This is a code block without any specific language
+</code></pre>
+
+<p>This is a code block specifying a language:</p>
+
+<pre><code class="language-ruby">class Something
+  def method(param)
+  end
+end
+</code></pre>

data/spec/fixtures/code_highlight.text

@@ -0,0 +1,20 @@
+This is a code block using 4 spaces syntax:
+    class Something
+      def method(param)
+      end
+    end
+
+This is a code block using 3-backticks ```:
+
+```
+This is a code block without any specific language
+```
+
+This is a code block specifying a language:
+
+```ruby
+class Something
+  def method(param)
+  end
+end
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +135,7 @@ files:
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -131,8 +146,11 @@ files:
 - lib/gitlab_kramdown.rb
 - lib/gitlab_kramdown/parser.rb
 - lib/gitlab_kramdown/parser/fenced_blockquote.rb
+- lib/gitlab_kramdown/parser/fenced_codeblock.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/multi_blockquote.html
 - spec/fixtures/multi_blockquote.text
 - spec/fixtures/references.html
@@ -150,9 +168,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="