enable CommonMark as the default

8 files changed, 106 insertions, 31 deletions

diff --git a/spec/features/markdown/copy_as_gfm_spec.rb b/spec/features/markdown/copy_as_gfm_spec.rb
index 4d897f09b57..05228e27963 100644
--- a/spec/features/markdown/copy_as_gfm_spec.rb
+++ b/spec/features/markdown/copy_as_gfm_spec.rb
@@ -502,6 +502,13 @@ describe 'Copy as GFM', :js do
               1. Numbered lists
         GFM
 
+        # list item followed by an HR
+        <<-GFM.strip_heredoc,
+          - list item
+
+          -----
+        GFM
+
         '# Heading',
         '## Heading',
         '### Heading',
@@ -515,8 +522,6 @@ describe 'Copy as GFM', :js do
 
         '~~Strikethrough~~',
 
-        '2^2',
-
         '-----',
 
         # table
diff --git a/spec/features/markdown/markdown_spec.rb b/spec/features/markdown/markdown_spec.rb
index c86ba8c50a5..cac8a5068ec 100644
--- a/spec/features/markdown/markdown_spec.rb
+++ b/spec/features/markdown/markdown_spec.rb
@@ -44,7 +44,7 @@ describe 'GitLab Markdown', :aggregate_failures do
 
   # Shared behavior that all pipelines should exhibit
   shared_examples 'all pipelines' do
-    it 'includes Redcarpet extensions' do
+    it 'includes extensions' do
       aggregate_failures 'does not parse emphasis inside of words' do
         expect(doc.to_html).not_to match('foo<em>bar</em>baz')
       end
@@ -72,10 +72,6 @@ describe 'GitLab Markdown', :aggregate_failures do
       aggregate_failures 'parses strikethroughs' do
         expect(doc).to have_selector(%{del:contains("and this text doesn't")})
       end
-
-      aggregate_failures 'parses superscript' do
-        expect(doc).to have_selector('sup', count: 2)
-      end
     end
 
     it 'includes SanitizationFilter' do
@@ -123,16 +119,24 @@ describe 'GitLab Markdown', :aggregate_failures do
         expect(doc).to have_selector('details summary:contains("collapsible")')
       end
 
-      aggregate_failures 'permits style attribute in th elements' do
-        expect(doc.at_css('th:contains("Header")')['style']).to eq 'text-align: center'
-        expect(doc.at_css('th:contains("Row")')['style']).to eq 'text-align: right'
-        expect(doc.at_css('th:contains("Example")')['style']).to eq 'text-align: left'
+      aggregate_failures 'permits align attribute in th elements' do
+        expect(doc.at_css('th:contains("Header")')['align']).to eq 'center'
+        expect(doc.at_css('th:contains("Row")')['align']).to eq 'right'
+        expect(doc.at_css('th:contains("Example")')['align']).to eq 'left'
       end
 
-      aggregate_failures 'permits style attribute in td elements' do
-        expect(doc.at_css('td:contains("Foo")')['style']).to eq 'text-align: center'
-        expect(doc.at_css('td:contains("Bar")')['style']).to eq 'text-align: right'
-        expect(doc.at_css('td:contains("Baz")')['style']).to eq 'text-align: left'
+      aggregate_failures 'permits align attribute in td elements' do
+        expect(doc.at_css('td:contains("Foo")')['align']).to eq 'center'
+        expect(doc.at_css('td:contains("Bar")')['align']).to eq 'right'
+        expect(doc.at_css('td:contains("Baz")')['align']).to eq 'left'
+      end
+
+      aggregate_failures 'permits superscript elements' do
+        expect(doc).to have_selector('sup', count: 2)
+      end
+
+      aggregate_failures 'permits subscript elements' do
+        expect(doc).to have_selector('sub', count: 3)
       end
 
       aggregate_failures 'removes `rel` attribute from links' do
@@ -320,6 +324,31 @@ describe 'GitLab Markdown', :aggregate_failures do
     end
   end
 
+  context 'Redcarpet documents' do
+    before do
+      allow_any_instance_of(Banzai::Filter::MarkdownFilter).to receive(:engine).and_return('Redcarpet')
+      @html = markdown(@feat.raw_markdown)
+    end
+
+    it 'processes certain elements differently' do
+      aggregate_failures 'parses superscript' do
+        expect(doc).to have_selector('sup', count: 3)
+      end
+
+      aggregate_failures 'permits style attribute in th elements' do
+        expect(doc.at_css('th:contains("Header")')['style']).to eq 'text-align: center'
+        expect(doc.at_css('th:contains("Row")')['style']).to eq 'text-align: right'
+        expect(doc.at_css('th:contains("Example")')['style']).to eq 'text-align: left'
+      end
+
+      aggregate_failures 'permits style attribute in td elements' do
+        expect(doc.at_css('td:contains("Foo")')['style']).to eq 'text-align: center'
+        expect(doc.at_css('td:contains("Bar")')['style']).to eq 'text-align: right'
+        expect(doc.at_css('td:contains("Baz")')['style']).to eq 'text-align: left'
+      end
+    end
+  end
+
   # Fake a `current_user` helper
   def current_user
     @feat.user
diff --git a/spec/features/task_lists_spec.rb b/spec/features/task_lists_spec.rb
index 2dc3c5e3927..f37d8998045 100644
--- a/spec/features/task_lists_spec.rb
+++ b/spec/features/task_lists_spec.rb
@@ -36,7 +36,7 @@ feature 'Task Lists' do
     MARKDOWN
   end
 
-  let(:nested_tasks_markdown) do
+  let(:nested_tasks_markdown_redcarpet) do
     <<-EOT.strip_heredoc
     - [ ] Task a
       - [x] Task a.1
@@ -49,6 +49,19 @@ feature 'Task Lists' do
     EOT
   end
 
+  let(:nested_tasks_markdown) do
+    <<-EOT.strip_heredoc
+    - [ ] Task a
+      - [x] Task a.1
+      - [ ] Task a.2
+    - [ ] Task b
+
+    1. [ ] Task 1
+       1. [ ] Task 1.1
+       1. [x] Task 1.2
+    EOT
+  end
+
   before do
     Warden.test_mode!
 
@@ -141,13 +154,11 @@ feature 'Task Lists' do
       end
     end
 
-    describe 'nested tasks', :js do
-      let(:issue) { create(:issue, description: nested_tasks_markdown, author: user, project: project) }
-
+    shared_examples 'shared nested tasks' do
       before do
+        allow(Banzai::Filter::MarkdownFilter).to receive(:engine).and_return('Redcarpet')
         visit_issue(project, issue)
       end
-
       it 'renders' do
         expect(page).to have_selector('ul.task-list',      count: 2)
         expect(page).to have_selector('li.task-list-item', count: 7)
@@ -171,6 +182,30 @@ feature 'Task Lists' do
         expect(page).to have_content('marked the task Task 1.1 as complete')
       end
     end
+
+    describe 'nested tasks', :js do
+      context 'with Redcarpet' do
+        let(:issue) { create(:issue, description: nested_tasks_markdown_redcarpet, author: user, project: project) }
+
+        before do
+          allow_any_instance_of(Banzai::Filter::MarkdownFilter).to receive(:engine).and_return('Redcarpet')
+          visit_issue(project, issue)
+        end
+
+        it_behaves_like 'shared nested tasks'
+      end
+
+      context 'with CommonMark' do
+        let(:issue) { create(:issue, description: nested_tasks_markdown, author: user, project: project) }
+
+        before do
+          allow_any_instance_of(Banzai::Filter::MarkdownFilter).to receive(:engine).and_return('CommonMark')
+          visit_issue(project, issue)
+        end
+
+        it_behaves_like 'shared nested tasks'
+      end
+    end
   end
 
   describe 'for Notes' do
diff --git a/spec/fixtures/markdown.md.erb b/spec/fixtures/markdown.md.erb
index da32a46675f..e5d01c3bd03 100644
--- a/spec/fixtures/markdown.md.erb
+++ b/spec/fixtures/markdown.md.erb
@@ -43,8 +43,14 @@ This text says this, ~~and this text doesn't~~.
 
 ### Superscript
 
-This is my 1^(st) time using superscript in Markdown. Now this is my
-2^(nd).
+This is my 1<sup>(st)</sup> time using superscript in Markdown. Now this is my
+2<sup>(nd)</sup>.
+
+Redcarpet supports this superscript syntax ( x^2 ).
+
+### Subscript
+
+This (C<sub>6</sub>H<sub>12</sub>O<sub>6</sub>) is an example of subscripts in Markdown.
 
 ### Next step
 
diff --git a/spec/helpers/markup_helper_spec.rb b/spec/helpers/markup_helper_spec.rb
index c0dc9293397..1a720aae55c 100644
--- a/spec/helpers/markup_helper_spec.rb
+++ b/spec/helpers/markup_helper_spec.rb
@@ -298,7 +298,7 @@ describe MarkupHelper do
 
       it 'preserves code color scheme' do
         object = create_object("```ruby\ndef test\n  'hello world'\nend\n```")
-        expected = "\n<pre class=\"code highlight js-syntax-highlight ruby\">" \
+        expected = "<pre class=\"code highlight js-syntax-highlight ruby\">" \
           "<code><span class=\"line\"><span class=\"k\">def</span> <span class=\"nf\">test</span>...</span>\n" \
           "</code></pre>"
 
diff --git a/spec/javascripts/shortcuts_issuable_spec.js b/spec/javascripts/shortcuts_issuable_spec.js
index d73608ed0ed..b10d8be6781 100644
--- a/spec/javascripts/shortcuts_issuable_spec.js
+++ b/spec/javascripts/shortcuts_issuable_spec.js
@@ -66,7 +66,7 @@ describe('ShortcutsIssuable', function () {
     });
     describe('with a multi-line selection', () => {
       it('quotes the selected lines as a group', () => {
-        stubSelection('<p>Selected line one.</p>\n\n<p>Selected line two.</p>\n\n<p>Selected line three.</p>');
+        stubSelection('<p>Selected line one.</p>\n<p>Selected line two.</p>\n<p>Selected line three.</p>');
         this.shortcut.replyWithSelectedText(true);
         expect($(this.selector).val()).toBe('> Selected line one.\n>\n> Selected line two.\n>\n> Selected line three.\n\n');
       });
diff --git a/spec/lib/banzai/filter/markdown_filter_spec.rb b/spec/lib/banzai/filter/markdown_filter_spec.rb
index 00c407d1b69..ab14d77d552 100644
--- a/spec/lib/banzai/filter/markdown_filter_spec.rb
+++ b/spec/lib/banzai/filter/markdown_filter_spec.rb
@@ -7,13 +7,13 @@ describe Banzai::Filter::MarkdownFilter do
     it 'adds language to lang attribute when specified' do
       result = filter("```html\nsome code\n```")
 
-      expect(result).to start_with("\n<pre><code lang=\"html\">")
+      expect(result).to start_with("<pre><code lang=\"html\">")
     end
 
     it 'does not add language to lang attribute when not specified' do
       result = filter("```\nsome code\n```")
 
-      expect(result).to start_with("\n<pre><code>")
+      expect(result).to start_with("<pre><code>")
     end
   end
 end
diff --git a/spec/models/concerns/cache_markdown_field_spec.rb b/spec/models/concerns/cache_markdown_field_spec.rb
index b3797c1fb46..2d75422ee68 100644
--- a/spec/models/concerns/cache_markdown_field_spec.rb
+++ b/spec/models/concerns/cache_markdown_field_spec.rb
@@ -156,7 +156,7 @@ describe CacheMarkdownField do
     end
 
     it { expect(thing.foo_html).to eq(updated_html) }
-    it { expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_REDCARPET_VERSION) }
+    it { expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_COMMONMARK_VERSION) }
   end
 
   describe '#cached_html_up_to_date?' do
@@ -234,7 +234,7 @@ describe CacheMarkdownField do
 
     it 'returns default version when version is nil' do
       thing.cached_markdown_version = nil
-      is_expected.to eq(CacheMarkdownField::CACHE_REDCARPET_VERSION)
+      is_expected.to eq(CacheMarkdownField::CACHE_COMMONMARK_VERSION)
     end
   end
 
@@ -261,7 +261,7 @@ describe CacheMarkdownField do
       thing.cached_markdown_version = nil
       thing.refresh_markdown_cache
 
-      expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_REDCARPET_VERSION)
+      expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_COMMONMARK_VERSION)
     end
   end
 
@@ -346,7 +346,7 @@ describe CacheMarkdownField do
 
         expect(thing.foo_html).to eq(updated_html)
         expect(thing.baz_html).to eq(updated_html)
-        expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_REDCARPET_VERSION)
+        expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_COMMONMARK_VERSION)
       end
     end
 
@@ -366,7 +366,7 @@ describe CacheMarkdownField do
 
         expect(thing.foo_html).to eq(updated_html)
         expect(thing.baz_html).to eq(updated_html)
-        expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_REDCARPET_VERSION)
+        expect(thing.cached_markdown_version).to eq(CacheMarkdownField::CACHE_COMMONMARK_VERSION)
       end
     end
   end