aboutsummaryrefslogtreecommitdiff
path: root/site/src/main/jekyll/_plugins/pygments_code.rb
blob: bb70a3b769132fa6847b5bd99018dafba74277b0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
require 'pygments'
require 'fileutils'
require 'digest/md5'

module Octopress
  module Pygments

    def self.render_pygments(code, lang)
      highlighted_code = ::Pygments.highlight(code, :lexer => lang, :formatter => 'html', :options => {:encoding => 'utf-8'})
      highlighted_code = highlighted_code.gsub(/{{/, '{{').gsub(/{%/, '{%')
      highlighted_code.to_s
    end

    def self.highlight(code, options = {})
      lang = options[:lang]
      lang = 'ruby' if lang == 'ru'
      lang = 'objc' if lang == 'm'
      lang = 'perl' if lang == 'pl'
      lang = 'yaml' if lang == 'yml'
      lang = 'coffeescript' if lang == 'coffee'
      lang = 'csharp' if lang == 'cs'
      lang = 'plain' if lang == '' or lang.nil? or !lang

      options[:lang] = lang
      options[:title] ||= ' ' if options[:url]
      options[:no_cache] = true

      # Attempt to retrieve cached code
      cache = nil
      unless options[:no_cache]
        path  = options[:cache_path] || get_cache_path(PYGMENTS_CACHE_DIR, options[:lang], options.to_s + code)
        cache = read_cache(path)
      end

      unless cache
       if options[:lang] == 'plain'
          # Escape html tags
          code = code.gsub('<','&lt;')
        else
          code = render_pygments(code, options[:lang]).match(/<pre>(.+)<\/pre>/m)[1].gsub(/ *$/, '') #strip out divs <div class="highlight">
        end
        code = tableize_code(code, options[:lang], {linenos: options[:linenos], start: options[:start], marks: options[:marks]})
        code = "<figure class='code'>#{code}</figure>"
        File.open(path, 'w') {|f| f.print(code) } unless options[:no_cache]
      end
      cache || code
    end

    def self.read_cache (path)
      File.exist?(path) ? File.read(path) : nil unless path.nil?
    end

    def self.get_cache_path (dir, name, str)
      File.join(dir, "#{name}-#{Digest::MD5.hexdigest(str)}.html")
    end

    def self.captionize (caption, url, link_text)
      figcaption  = "<figcaption>#{caption}"
      figcaption += "<a href='#{url}'>#{(link_text || 'link').strip}</a>" if url
      figcaption += "</figcaption>"
    end

    def self.tableize_code (code, lang, options = {})
      start = options[:start] || 1
      lines = options[:linenos] || true
      marks = options[:marks] || []
      table = "<div class='highlight'><table><tr>"

      if lines == true
        table += number_lines(start, code.lines.count, marks) if lines
      end

      table += "<td class='main #{'unnumbered' unless lines} #{lang}'><pre>"
      code.lines.each_with_index do |line,index|
        classes = 'line'
        if marks.include? index + start
          classes += ' bg-warning'
          classes += ' start' unless marks.include? index - 1 + start
          classes += ' end' unless marks.include? index + 1 + start
        end
        line = line.strip.empty? ? ' ' : line
        table += "<div class='#{classes}'>#{line}</div>"
      end
      table +="</pre></td></tr></table></div>"
    end

    def self.number_lines (start, count, marks)
      start ||= 1
      lines = "<td class='line-numbers' aria-hidden='true'><pre>"
      count.times do |index|
        classes = 'line-number'
        if marks.include? index + start
          classes += ' marked'
          classes += ' start' unless marks.include? index - 1 + start
          classes += ' end' unless marks.include? index + 1 + start
        end
        lines += "<div data-line='#{index + start}' class='#{classes}'></div>"
      end
      lines += "</pre></td>"
    end

    def self.parse_markup (input, defaults={})
      lang      = input.match(/\s*lang:\s*(\S+)/i)
      lang      = (lang.nil? ? nil : lang[1])

      url       = input.match(/\s*url:\s*(("(.+?)")|('(.+?)')|(\S+))/i)
      url       = (url.nil? ? nil : url[3] || url[5] || url[6])

      title     = input.match(/\s*title:\s*(("(.+?)")|('(.+?)')|(\S+))/i)
      title     = (title.nil? ? nil : title[3] || title[5] || title[6])
      title   ||= ' ' if url

      linenos   = input.match(/\s*linenos:\s*(\w+)/i)
      linenos   = (linenos.nil? ? nil : linenos[1])

      marks     = get_marks(input)

      link_text = input.match(/\s*link[-_]text:\s*(("(.+?)")|('(.+?)')|(\S+))/i)
      link_text = (link_text.nil? ? 'link' : link_text[3] || link_text[5] || link_text[6])

      start     = input.match(/\s*start:\s*(\d+)/i)
      start     = (start.nil? ? nil : start[1].to_i)

      endline   = input.match(/\s*end:\s*(\d+)/i)
      endline   = (endline.nil? ? nil : endline[1].to_i)

      if input =~ / *range:(\d+)-(\d+)/i
        start = $1.to_i
        endline = $2.to_i
      end

      options = {
        lang: lang,
        url: url,
        title: title,
        linenos: linenos,
        marks: marks,
        link_text: link_text,
        start: start,
        end: endline
      }

      #defaults.each { |k,v| options[k] ||= defaults[k] }
      options.each { |k,v| options[k] ||= defaults[k] }
    end

    def self.clean_markup (input)
      input.sub(/\s*lang:\s*\S+/i,''
          ).sub(/\s*title:\s*(("(.+?)")|('(.+?)')|(\S+))/i,''
          ).sub(/\s*url:\s*(\S+)/i,''
          ).sub(/\s*link_text:\s*(("(.+?)")|('(.+?)')|(\S+))/i,''
          ).sub(/\s*mark:\s*\d\S*/i,''
          ).sub(/\s*linenos:\s*\w+/i,''
          ).sub(/\s*start:\s*\d+/i,''
          ).sub(/\s*end:\s*\d+/i,''
          ).sub(/\s*range:\s*\d+-\d+/i,'')
    end

    def self.get_marks (input)
      # Matches pattern for line marks and returns array of line numbers to mark
      # Example input mark:1,5-10,2
      # Outputs: [1,2,5,6,7,8,9,10]
      marks = []
      if input =~ / *mark:(\d\S*)/i
        marks = $1.gsub /(\d+)-(\d+)/ do
          ($1.to_i..$2.to_i).to_a.join(',')
        end
        marks = marks.split(',').collect {|s| s.to_i}.sort
      end
      marks
    end

    def self.get_range (code, start, endline)
      length    = code.lines.count
      start   ||= 1
      endline ||= length
      if start > 1 or endline < length
        raise "#{filepath} is #{length} lines long, cannot begin at line #{start}" if start > length
        raise "#{filepath} is #{length} lines long, cannot read beyond line #{endline}" if endline > length
        code = code.split(/\n/).slice(start - 1, endline + 1 - start).join("\n")
      end
      code
    end

    def self.highlight_failed(error, syntax, markup, code, file = nil)
      code_snippet = code.split("\n")[0..9].map{|l| "    #{l}" }.join("\n")
      fail_message  = "\nPygments Error while parsing the following markup#{" in #{file}" if file}:\n\n".red
      fail_message += "    #{markup}\n#{code_snippet}\n"
      fail_message += "#{"    ..." if code.split("\n").size > 10}\n"
      fail_message += "\nValid Syntax:\n\n#{syntax}\n".yellow
      fail_message += "\nPygments Error:\n\n#{error.message}".red
      $stderr.puts fail_message.chomp
      raise ArgumentError
    end
  end
end