copy_as_gfm_spec.rb 16.7 KB
Newer Older
1 2 3
require 'spec_helper'

describe 'Copy as GFM', feature: true, js: true do
4
  include MarkupHelper
5
  include RepoHelpers
6 7 8
  include ActionView::Helpers::JavaScriptHelper

  before do
9 10
    login_as :admin
  end
11

12 13 14
  describe 'Copying rendered GFM' do
    before do
      @feat = MarkdownFeature.new
15

16 17
      # `markdown` helper expects a `@project` variable
      @project = @feat.project
18

19 20
      visit namespace_project_issue_path(@project.namespace, @project, @feat.issue)
    end
21

22
    # The filters referenced in lib/banzai/pipeline/gfm_pipeline.rb convert GitLab Flavored Markdown (GFM) to HTML.
23
    # The handlers defined in app/assets/javascripts/copy_as_gfm.js consequently convert that same HTML to GFM.
24 25
    # To make sure these filters and handlers are properly aligned, this spec tests the GFM-to-HTML-to-GFM cycle
    # by verifying (`html_to_gfm(gfm_to_html(gfm)) == gfm`) for a number of examples of GFM for every filter, using the `verify` helper.
Douwe Maan's avatar
Douwe Maan committed
26

27 28 29 30
    # These are all in a single `it` for performance reasons.
    it 'works', :aggregate_failures do
      verify(
        'nesting',
Douwe Maan's avatar
Douwe Maan committed
31

32 33
        '> 1. [x] **[$`2 + 2`$ {-=-}{+=+} 2^2 ~~:thumbsup:~~](http://google.com)**'
      )
34

35 36
      verify(
        'a real world example from the gitlab-ce README',
37

38 39
        <<-GFM.strip_heredoc
          # GitLab
40

41 42 43 44
          [![Build status](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-ce/commits/master)
          [![CE coverage report](https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage)](https://gitlab-org.gitlab.io/gitlab-ce/coverage-ruby)
          [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.svg)](https://codeclimate.com/github/gitlabhq/gitlabhq)
          [![Core Infrastructure Initiative Best Practices](https://bestpractices.coreinfrastructure.org/projects/42/badge)](https://bestpractices.coreinfrastructure.org/projects/42)
45

46
          ## Canonical source
47

48
          The canonical source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/).
49

50
          ## Open source software to collaborate on code
51

52
          To see how GitLab looks please see the [features page on our website](https://about.gitlab.com/features/).
53 54


55
          - Manage Git repositories with fine grained access controls that keep your code secure
56

57
          - Perform code reviews and enhance collaboration with merge requests
58

59
          - Complete continuous integration (CI) and CD pipelines to builds, test, and deploy your applications
60

61
          - Each project can also have an issue tracker, issue board, and a wiki
62

63
          - Used by more than 100,000 organizations, GitLab is the most popular solution to manage Git repositories on-premises
Douwe Maan's avatar
Douwe Maan committed
64

65 66 67
          - Completely free and open source (MIT Expat license)
        GFM
      )
68

69 70
      verify(
        'InlineDiffFilter',
Douwe Maan's avatar
Douwe Maan committed
71

72 73 74
        '{-Deleted text-}',
        '{+Added text+}'
      )
75

76 77
      verify(
        'TaskListFilter',
Douwe Maan's avatar
Douwe Maan committed
78

79 80 81 82 83
        '- [ ] Unchecked task',
        '- [x] Checked task',
        '1. [ ] Unchecked numbered task',
        '1. [x] Checked numbered task'
      )
84

85 86
      verify(
        'ReferenceFilter',
Douwe Maan's avatar
Douwe Maan committed
87

88 89 90 91 92 93 94 95 96 97 98
        # issue reference
        @feat.issue.to_reference,
        # full issue reference
        @feat.issue.to_reference(full: true),
        # issue URL
        namespace_project_issue_url(@project.namespace, @project, @feat.issue),
        # issue URL with note anchor
        namespace_project_issue_url(@project.namespace, @project, @feat.issue, anchor: 'note_123'),
        # issue link
        "[Issue](#{namespace_project_issue_url(@project.namespace, @project, @feat.issue)})",
        # issue link with note anchor
99
        "[Issue](#{namespace_project_issue_url(@project.namespace, @project, @feat.issue, anchor: 'note_123')})"
100
      )
Douwe Maan's avatar
Douwe Maan committed
101

102 103
      verify(
        'AutolinkFilter',
Douwe Maan's avatar
Douwe Maan committed
104

105 106
        'https://example.com'
      )
Douwe Maan's avatar
Douwe Maan committed
107

108 109
      verify(
        'TableOfContentsFilter',
Douwe Maan's avatar
Douwe Maan committed
110

111 112
        '[[_TOC_]]'
      )
Douwe Maan's avatar
Douwe Maan committed
113

114 115
      verify(
        'EmojiFilter',
116

117 118
        ':thumbsup:'
      )
119

120 121 122 123 124
      verify(
        'ImageLinkFilter',

        '![Image](https://example.com/image.png)'
      )
125

126 127
      verify(
        'VideoLinkFilter',
128

129 130
        '![Video](https://example.com/video.mp4)'
      )
131

132 133
      verify(
        'MathFilter: math as converted from GFM to HTML',
134

135
        '$`c = \pm\sqrt{a^2 + b^2}`$',
136

137 138 139 140 141 142 143
        # math block
        <<-GFM.strip_heredoc
          ```math
          c = \pm\sqrt{a^2 + b^2}
          ```
        GFM
      )
144

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
      aggregate_failures('MathFilter: math as transformed from HTML to KaTeX') do
        gfm = '$`c = \pm\sqrt{a^2 + b^2}`$'

        html = <<-HTML.strip_heredoc
          <span class="katex">
            <span class="katex-mathml">
              <math>
                <semantics>
                  <mrow>
                    <mi>c</mi>
                    <mo>=</mo>
                    <mo>±</mo>
                    <msqrt>
                      <mrow>
                        <msup>
                          <mi>a</mi>
                          <mn>2</mn>
                        </msup>
                        <mo>+</mo>
                        <msup>
                          <mi>b</mi>
                          <mn>2</mn>
                        </msup>
                      </mrow>
                    </msqrt>
                  </mrow>
                  <annotation encoding="application/x-tex">c = \\pm\\sqrt{a^2 + b^2}</annotation>
                </semantics>
              </math>
            </span>
            <span class="katex-html" aria-hidden="true">
                <span class="strut" style="height: 0.913389em;"></span>
                <span class="strut bottom" style="height: 1.04em; vertical-align: -0.126611em;"></span>
                <span class="base textstyle uncramped">
                  <span class="mord mathit">c</span>
                  <span class="mrel">=</span>
                  <span class="mord">±</span>
                  <span class="sqrt mord"><span class="sqrt-sign" style="top: -0.073389em;">
                    <span class="style-wrap reset-textstyle textstyle uncramped">√</span>
                  </span>
                  <span class="vlist">
                    <span class="" style="top: 0em;">
                      <span class="fontsize-ensurer reset-size5 size5">
                        <span class="" style="font-size: 1em;">​</span>
                      </span>
                      <span class="mord textstyle cramped">
                        <span class="mord">
                          <span class="mord mathit">a</span>
                          <span class="msupsub">
                            <span class="vlist">
                              <span class="" style="top: -0.289em; margin-right: 0.05em;">
                                <span class="fontsize-ensurer reset-size5 size5">
                                  <span class="" style="font-size: 0em;">​</span>
                                </span>
                                <span class="reset-textstyle scriptstyle cramped">
                                  <span class="mord mathrm">2</span>
                                </span>
202
                              </span>
203 204 205 206 207
                              <span class="baseline-fix">
                                <span class="fontsize-ensurer reset-size5 size5">
                                  <span class="" style="font-size: 0em;">​</span>
                                </span>
                              ​</span>
208 209 210
                            </span>
                          </span>
                        </span>
211 212 213 214 215 216 217 218 219 220 221 222
                        <span class="mbin">+</span>
                        <span class="mord">
                          <span class="mord mathit">b</span>
                          <span class="msupsub">
                            <span class="vlist">
                              <span class="" style="top: -0.289em; margin-right: 0.05em;">
                                <span class="fontsize-ensurer reset-size5 size5">
                                  <span class="" style="font-size: 0em;">​</span>
                                </span>
                                <span class="reset-textstyle scriptstyle cramped">
                                  <span class="mord mathrm">2</span>
                                </span>
223
                              </span>
224 225 226 227 228
                              <span class="baseline-fix">
                                <span class="fontsize-ensurer reset-size5 size5">
                                  <span class="" style="font-size: 0em;">​</span>
                                </span>
                              ​</span>
229 230 231 232 233
                            </span>
                          </span>
                        </span>
                      </span>
                    </span>
234 235 236 237 238
                    <span class="" style="top: -0.833389em;">
                      <span class="fontsize-ensurer reset-size5 size5">
                        <span class="" style="font-size: 1em;">​</span>
                      </span>
                      <span class="reset-textstyle textstyle uncramped sqrt-line"></span>
239
                    </span>
240 241 242 243 244
                    <span class="baseline-fix">
                      <span class="fontsize-ensurer reset-size5 size5">
                        <span class="" style="font-size: 1em;">​</span>
                      </span>
                    ​</span>
245 246 247 248 249
                  </span>
                </span>
              </span>
            </span>
          </span>
250
        HTML
251

252 253 254
        output_gfm = html_to_gfm(html)
        expect(output_gfm.strip).to eq(gfm.strip)
      end
255

256 257
      verify(
        'SanitizationFilter',
258

259 260
        <<-GFM.strip_heredoc
        <a name="named-anchor"></a>
261

262
        <sub>sub</sub>
263

264 265 266 267
        <dl>
          <dt>dt</dt>
          <dd>dd</dd>
        </dl>
268

269
        <kbd>kbd</kbd>
270

271
        <q>q</q>
272

273
        <samp>samp</samp>
274

275
        <var>var</var>
276

277
        <ruby>ruby</ruby>
278

279
        <rt>rt</rt>
280

281
        <rp>rp</rp>
282

283
        <abbr>abbr</abbr>
284

285
        <summary>summary</summary>
286

287 288 289
        <details>details</details>
        GFM
      )
290

291 292
      verify(
        'SanitizationFilter',
293

294 295 296 297 298
        <<-GFM.strip_heredoc,
          ```
          Plain text
          ```
        GFM
299

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
        <<-GFM.strip_heredoc,
          ```ruby
          def foo
            bar
          end
          ```
        GFM

        <<-GFM.strip_heredoc
          Foo

              This is an example of GFM

              ```js
              Code goes here
              ```
        GFM
      )

      verify(
        'MarkdownFilter',

        "Line with two spaces at the end  \nto insert a linebreak",

        '`code`',
        '`` code with ` ticks ``',

        '> Quote',

        # multiline quote
        <<-GFM.strip_heredoc,
          > Multiline
          > Quote
          >
          > With multiple paragraphs
        GFM

        '![Image](https://example.com/image.png)',

        '# Heading with no anchor link',

        '[Link](https://example.com)',

        '- List item',

        # multiline list item
        <<-GFM.strip_heredoc,
          - Multiline
              List item
        GFM

        # nested lists
        <<-GFM.strip_heredoc,
          - Nested


              - Lists
        GFM

        # list with blockquote
        <<-GFM.strip_heredoc,
          - List

              > Blockquote
        GFM

        '1. Numbered list item',

        # multiline numbered list item
        <<-GFM.strip_heredoc,
          1. Multiline
              Numbered list item
        GFM

        # nested numbered list
        <<-GFM.strip_heredoc,
          1. Nested
377

378

379 380
              1. Numbered lists
        GFM
381

382 383 384 385 386 387
        '# Heading',
        '## Heading',
        '### Heading',
        '#### Heading',
        '##### Heading',
        '###### Heading',
Douwe Maan's avatar
Douwe Maan committed
388

389
        '**Bold**',
390

391
        '_Italics_',
392

393
        '~~Strikethrough~~',
394

395
        '2^2',
396

397
        '-----',
398

399 400 401 402 403 404 405
        # table
        <<-GFM.strip_heredoc,
          | Centered | Right | Left |
          |:--------:|------:|------|
          | Foo | Bar | **Baz** |
          | Foo | Bar | **Baz** |
        GFM
406

407 408 409 410 411 412 413 414 415
        # table with empty heading
        <<-GFM.strip_heredoc,
          |  | x | y |
          |---|---|---|
          | a | 1 | 0 |
          | b | 0 | 1 |
        GFM
      )
    end
416

417
    alias_method :gfm_to_html, :markdown
418

419 420 421 422 423 424 425 426 427
    def verify(label, *gfms)
      aggregate_failures(label) do
        gfms.each do |gfm|
          html = gfm_to_html(gfm)
          output_gfm = html_to_gfm(html)
          expect(output_gfm.strip).to eq(gfm.strip)
        end
      end
    end
Douwe Maan's avatar
Douwe Maan committed
428

429 430 431 432 433
    # Fake a `current_user` helper
    def current_user
      @feat.user
    end
  end
Douwe Maan's avatar
Douwe Maan committed
434

435
  describe 'Copying code' do
436
    let(:project) { create(:project, :repository) }
Douwe Maan's avatar
Douwe Maan committed
437

438 439 440 441
    context 'from a diff' do
      before do
        visit namespace_project_commit_path(project.namespace, project, sample_commit.id)
      end
Douwe Maan's avatar
Douwe Maan committed
442

443 444 445 446
      context 'selecting one word of text' do
        it 'copies as inline code' do
          verify(
            '[id="2f6fcd96b88b36ce98c38da085c795a27d92a3dd_10_9"] .line .no',
447

448 449 450 451
            '`RuntimeError`'
          )
        end
      end
452

453 454 455 456
      context 'selecting one line of text' do
        it 'copies as inline code' do
          verify(
            '[id="2f6fcd96b88b36ce98c38da085c795a27d92a3dd_10_9"] .line',
Douwe Maan's avatar
Douwe Maan committed
457

458 459 460 461
            '`raise RuntimeError, "System commands must be given as an array of strings"`'
          )
        end
      end
Douwe Maan's avatar
Douwe Maan committed
462

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
      context 'selecting multiple lines of text' do
        it 'copies as a code block' do
          verify(
            '[id="2f6fcd96b88b36ce98c38da085c795a27d92a3dd_10_9"], [id="2f6fcd96b88b36ce98c38da085c795a27d92a3dd_10_10"]',

            <<-GFM.strip_heredoc,
              ```ruby
                    raise RuntimeError, "System commands must be given as an array of strings"
                  end
              ```
            GFM
          )
        end
      end
    end

    context 'from a blob' do
      before do
        visit namespace_project_blob_path(project.namespace, project, File.join('master', 'files/ruby/popen.rb'))
482
        wait_for_ajax
483
      end
Douwe Maan's avatar
Douwe Maan committed
484

485 486 487 488
      context 'selecting one word of text' do
        it 'copies as inline code' do
          verify(
            '.line[id="LC9"] .no',
Douwe Maan's avatar
Douwe Maan committed
489

490 491 492 493
            '`RuntimeError`'
          )
        end
      end
Douwe Maan's avatar
Douwe Maan committed
494

495 496 497 498
      context 'selecting one line of text' do
        it 'copies as inline code' do
          verify(
            '.line[id="LC9"]',
499

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
            '`raise RuntimeError, "System commands must be given as an array of strings"`'
          )
        end
      end

      context 'selecting multiple lines of text' do
        it 'copies as a code block' do
          verify(
            '.line[id="LC9"], .line[id="LC10"]',

            <<-GFM.strip_heredoc,
              ```ruby
                    raise RuntimeError, "System commands must be given as an array of strings"
                  end
              ```
            GFM
          )
        end
      end
    end
520

521 522 523
    context 'from a GFM code block' do
      before do
        visit namespace_project_blob_path(project.namespace, project, File.join('markdown', 'doc/api/users.md'))
524
        wait_for_ajax
525
      end
526

527 528 529 530
      context 'selecting one word of text' do
        it 'copies as inline code' do
          verify(
            '.line[id="LC27"] .s2',
531

532 533 534 535
            '`"bio"`'
          )
        end
      end
536

537 538 539 540
      context 'selecting one line of text' do
        it 'copies as inline code' do
          verify(
            '.line[id="LC27"]',
541

542 543 544 545
            '`"bio": null,`'
          )
        end
      end
546

547
      context 'selecting multiple lines of text' do
548
        it 'copies as a code block with the correct language' do
549 550 551 552 553 554 555 556 557 558 559 560 561
          verify(
            '.line[id="LC27"], .line[id="LC28"]',

            <<-GFM.strip_heredoc,
              ```json
                  "bio": null,
                  "skype": "",
              ```
            GFM
          )
        end
      end
    end
562

563 564
    def verify(selector, gfm)
      html = html_for_selector(selector)
Douwe Maan's avatar
Douwe Maan committed
565
      output_gfm = html_to_gfm(html, 'transformCodeSelection')
566 567
      expect(output_gfm.strip).to eq(gfm.strip)
    end
568 569
  end

570 571 572 573 574 575 576 577 578 579
  def html_for_selector(selector)
    js = <<-JS.strip_heredoc
      (function(selector) {
        var els = document.querySelectorAll(selector);
        var htmls = _.map(els, function(el) { return el.outerHTML; });
        return htmls.join("\\n");
      })("#{escape_javascript(selector)}")
    JS
    page.evaluate_script(js)
  end
Douwe Maan's avatar
Douwe Maan committed
580

581
  def html_to_gfm(html, transformer = 'transformGFMSelection')
582 583
    js = <<-JS.strip_heredoc
      (function(html) {
Douwe Maan's avatar
Douwe Maan committed
584 585
        var transformer = window.gl.CopyAsGFM[#{transformer.inspect}];

586 587
        var node = document.createElement('div');
        node.innerHTML = html;
Douwe Maan's avatar
Douwe Maan committed
588 589 590 591 592

        node = transformer(node);
        if (!node) return null;

        return window.gl.CopyAsGFM.nodeToGFM(node);
593 594 595 596 597
      })("#{escape_javascript(html)}")
    JS
    page.evaluate_script(js)
  end
end