Class: Gitlab::Highlight

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/highlight.rb

Constant Summary collapse

TIMEOUT_BACKGROUND =
30.seconds
TIMEOUT_FOREGROUND =
1.5.seconds

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(blob_name, blob_content, language: nil) ⇒ Highlight

Returns a new instance of Highlight.


19
20
21
22
23
24
# File 'lib/gitlab/highlight.rb', line 19

def initialize(blob_name, blob_content, language: nil)
  @formatter = Rouge::Formatters::HTMLGitlab
  @language = language
  @blob_name = blob_name
  @blob_content = blob_content
end

Instance Attribute Details

#blob_nameObject (readonly)

Returns the value of attribute blob_name.


17
18
19
# File 'lib/gitlab/highlight.rb', line 17

def blob_name
  @blob_name
end

Class Method Details

.highlight(blob_name, blob_content, language: nil, plain: false) ⇒ Object


8
9
10
11
# File 'lib/gitlab/highlight.rb', line 8

def self.highlight(blob_name, blob_content, language: nil, plain: false)
  new(blob_name, blob_content, language: language)
    .highlight(blob_content, continue: false, plain: plain)
end

.too_large?(size) ⇒ Boolean

Returns:

  • (Boolean)

13
14
15
# File 'lib/gitlab/highlight.rb', line 13

def self.too_large?(size)
  size.to_i > self.file_size_limit
end

Instance Method Details

#highlight(text, continue: false, plain: false, context: {}) ⇒ Object


26
27
28
29
30
31
32
33
34
# File 'lib/gitlab/highlight.rb', line 26

def highlight(text, continue: false, plain: false, context: {})
  @context = context

  plain ||= self.class.too_large?(text.length)

  highlighted_text = highlight_text(text, continue: continue, plain: plain)
  highlighted_text = link_dependencies(text, highlighted_text) if blob_name
  highlighted_text
end

#lexerObject


36
37
38
39
40
41
42
# File 'lib/gitlab/highlight.rb', line 36

def lexer
  @lexer ||= custom_language || begin
    Rouge::Lexer.guess(filename: @blob_name, source: @blob_content).new
  rescue Rouge::Guesser::Ambiguous => e
    e.alternatives.min_by(&:tag)
  end
end