Sha256: 27e914ddf7e5f3c6470795eee0c12ab52800f07705867258ca223c6adb13eaab

Contents?: true

Size: 1.47 KB

Versions: 8

Compression:

Stored size: 1.47 KB

Contents

# frozen_string_literal: true

HTML::Pipeline.require_dependency('rouge', 'SyntaxHighlightFilter')

module HTML
  class Pipeline
    # HTML Filter that syntax highlights text inside code blocks.
    #
    # Context options:
    #
    #   :highlight => String represents the language to pick lexer. Defaults to empty string.
    #   :scope => String represents the class attribute adds to pre element after.
    #             Defaults to "highlight highlight-css" if highlights a css code block.
    #
    # This filter does not write any additional information to the context hash.
    class SyntaxHighlightFilter < Filter
      def initialize(*args)
        super(*args)
        @formatter = Rouge::Formatters::HTML.new
      end

      def call
        doc.search('pre').each do |node|
          default = context[:highlight] && context[:highlight].to_s
          next unless lang = node['lang'] || default
          next unless lexer = lexer_for(lang)

          text = node.inner_text
          html = highlight_with_timeout_handling(text, lexer)
          next if html.nil?

          node.inner_html = html
          scope = context.fetch(:scope) { 'highlight' }
          node['class'] = "#{scope} #{scope}-#{lang}"
        end
        doc
      end

      def highlight_with_timeout_handling(text, lexer)
        Rouge.highlight(text, lexer, @formatter)
      rescue Timeout::Error => _
        nil
      end

      def lexer_for(lang)
        Rouge::Lexer.find(lang)
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
html-pipeline-2.14.3 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.14.2 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.14.1 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.13.2 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.13.1 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.14.0 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.13.0 lib/html/pipeline/syntax_highlight_filter.rb
html-pipeline-2.12.3 lib/html/pipeline/syntax_highlight_filter.rb