asciidoctor-rouge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 514ab17fada9d5d6be0a3fc05ae1f8faa5df71ff
+  data.tar.gz: d9fc422a4bd70c1df7096c5762fb87eaa00d54a2
+SHA512:
+  metadata.gz: b875cadbe7eb749630918d4849cd0858b413b287b1524cc53653d66878f492db990c69e3ba8602196eaaa186d715d64ba7da7b6fda4065c616ff673040ca8075
+  data.tar.gz: 5f490dde43ac3ef448bcb0f250f7d13fe1ed85dac38e68f445dbcf5714b3dea9fea9947837a3b093efb644241423a420eb4bb0cd23ee1d3d0c7642779df91f2d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2017 Jakub Jirutka <jakub@jirutka.cz>.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,50 @@
+= Asciidoctor Rouge
+:source-language: ruby
+// custom
+:gem-name: asciidoctor-rouge
+:gem-version: 0.1.0
+:gh-name: jirutka/{gem-name}
+:gh-branch: master
+:codacy-id: d2ed58f5f3f949a19bab7637fe7d0bdb
+
+ifdef::env-github[]
+image:https://travis-ci.org/{gh-name}.svg?branch={gh-branch}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://api.codacy.com/project/badge/Coverage/{codacy-id}["Test Coverage", link="https://www.codacy.com/app/{gh-name}"]
+image:https://api.codacy.com/project/badge/Grade/{codacy-id}["Codacy Code quality", link="https://www.codacy.com/app/{gh-name}"]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://img.shields.io/badge/yard-docs-blue.svg[Yard Docs, link="http://www.rubydoc.info/github/{gh-name}/{gh-branch}"]
+endif::env-github[]
+
+
+This project provides an http://asciidoctor.org/[Asciidoctor] extension for highlighting source listing blocks using http://rouge.jneen.net/[Rouge] – a pure-ruby code highlighter that is compatible with pygments.
+
+It supports all Asciidoctor features such as http://asciidoctor.org/docs/user-manual/#callouts[callouts], highlighting of specified lines (attribute `highlight`), http://asciidoctor.org/docs/user-manual/#passthroughs[passthroughs] inside a code and all other substitutions.
+
+This extension is highly customizable and modular.
+
+
+== Installation
+
+To install (or update to the latest version):
+
+[source, sh, subs="+attributes"]
+gem install {gem-name}
+
+or to install the latest development version:
+
+[source, sh, subs="+attributes"]
+gem install {gem-name} --pre
+
+
+== Usage
+
+Set attribute `source-highlighter` to `rouge`; globally or in the document.
+
+[source, sh, subs="+attributes"]
+asciidoctor -r {gem-name} -a source-highlighter=rouge Example.adoc
+
+
+== License
+
+This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
+For the full text of the license, see the link:LICENSE[LICENSE] file.

data/asciidoctor-rouge.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/asciidoctor/rouge/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'asciidoctor-rouge'
+  s.version     = Asciidoctor::Rouge::VERSION
+  s.author      = 'Jakub Jirutka'
+  s.email       = 'jakub@jirutka.cz'
+  s.homepage    = 'https://github.com/jirutka/asciidoctor-rouge'
+  s.license     = 'MIT'
+
+  s.summary     = 'Rouge code highlighter support for Asciidoctor'
+
+  s.files       = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+  s.has_rdoc    = 'yard'
+
+  s.required_ruby_version = '>= 2.1'
+
+  s.add_runtime_dependency 'asciidoctor', '~> 1.5.6'
+  s.add_runtime_dependency 'rouge', '~> 2.2'
+
+  s.add_development_dependency 'corefines', '~> 1.11'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
+  s.add_development_dependency 'simplecov', '~> 0.14'
+  s.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/asciidoctor-rouge.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'asciidoctor/rouge'

data/lib/asciidoctor/rouge.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'asciidoctor/extensions'
+require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/docinfo_processor'
+require 'asciidoctor/rouge/treeprocessor'
+
+Asciidoctor::Extensions.register do
+  treeprocessor Asciidoctor::Rouge::Treeprocessor
+  docinfo_processor Asciidoctor::Rouge::DocinfoProcessor
+end

data/lib/asciidoctor/rouge/callouts_substitutor.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require 'English'
+require 'asciidoctor'
+require 'asciidoctor/inline'
+require 'asciidoctor/substitutors'
+require 'asciidoctor/rouge/version'
+
+module Asciidoctor::Rouge
+  # A substitutor for processing callouts inside a source listing block.
+  class CalloutsSubstitutor
+
+    # @return [Hash<Integer, Array<Integer>>]
+    attr_reader :callouts
+
+    # @param node [Asciidoctor::AbstractNode]
+    # @return [CalloutsSubstitutor] a callouts substitutor for the given _node_.
+    def self.create(node)
+      new(node)
+    end
+
+    # Extracts and stashes callout markers from the given _text_ for
+    # reinsertion after processing.
+    #
+    # This should be used prior passing the source to a code highlighter.
+    #
+    # @param text [#each_line] source of the listing block.
+    # @return [String] a copy of the _text_ with callout marks removed.
+    def extract(text)
+      escape_char = ::Asciidoctor::Substitutors::RS
+      @callouts.clear
+
+      text.each_line.with_index.map { |line, ln|
+        line.gsub(@callout_rx) do
+          match = $LAST_MATCH_INFO
+          if match[1] == escape_char
+            # We have to use sub since we aren't sure it's the first char.
+            match[0].sub(escape_char, '')
+          else
+            (@callouts[ln] ||= []) << match[3].to_i
+            nil
+          end
+        end
+      }.join
+    end
+
+    # Converts and restores the extracted callouts for the given _text_.
+    #
+    # @param text [#each_line]
+    # @return [String] a copy of the _text_ with inserted callouts.
+    def restore(text)
+      return text if @callouts.empty?
+
+      text.each_line.with_index.map { |line, ln|
+        if (conums = @callouts.delete(ln))
+          line.chomp + conums.map { |num| convert_callout(num) }.join(' ') + "\n"
+        else
+          line
+        end
+      }.join
+    end
+
+    protected
+
+    # (see .create)
+    def initialize(node)
+      @node = node
+      @callouts = {}
+
+      @callout_rx = if node.attr? 'line-comment'
+        comment_rx = ::Regexp.escape(node.attr('line-comment'))
+        /(?:#{comment_rx} )?#{::Asciidoctor::CalloutExtractRxt}/
+      else
+        ::Asciidoctor::CalloutExtractRx
+      end
+    end
+
+    # @param number [Integer] callout number.
+    # @return [String] an HTML markup of callout with the given _number_.
+    def convert_callout(number)
+      ::Asciidoctor::Inline.new(@node, :callout, number, id: next_callout_id).convert
+    end
+
+    # @return [Integer] an unique ID for callout.
+    def next_callout_id
+      (@doc_callouts ||= @node.document.callouts).read_next_id
+    end
+  end
+end

data/lib/asciidoctor/rouge/docinfo_processor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'asciidoctor/rouge/version'
+require 'asciidoctor/extensions'
+require 'rouge'
+
+module Asciidoctor::Rouge
+  # A docinfo processor that embeds CSS for Rouge into the document's header.
+  class DocinfoProcessor < ::Asciidoctor::Extensions::DocinfoProcessor
+
+    # @param document [Asciidoctor::Document] the document to process.
+    # @return [String, nil]
+    def process(document)
+      return unless document.attr?('source-highlighter', 'rouge')
+      return unless document.attr('rouge-css', 'class') == 'class'
+
+      if (theme = ::Rouge::Theme.find(document.attr('rouge-theme', 'github')))
+        css = theme.render(scope: '.highlight')
+        ['<style>', css, '</style>'].join("\n")
+      end
+    end
+  end
+end

data/lib/asciidoctor/rouge/html_formatter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'asciidoctor/rouge/version'
+require 'rouge'
+
+module Asciidoctor::Rouge
+  # An HTML Rouge formatter with support for lines ID and highlighted lines.
+  class HtmlFormatter < ::Rouge::Formatter
+
+    tag 'asciidoctor_html'
+
+    # @param parent [Rouge::Formatter] the parent formatter; it must respond
+    #   to method +span(token, value)+. Defaults to +Rouge::Formatters::HTML+.
+    #
+    # @param highlight_lines [Array<Integer>] a list of line numbers (1-based)
+    #   to be highlighted (i.e. wrapped in +<strong></strong>+). Defaults to
+    #   empty array.
+    #
+    # @param highlight_class [String] CSS class to use on an element wrapping
+    #   highlighted lines (see above). Defaults to "highlighted".
+    #
+    # @param line_id [String] format string specifying +id+ for each line.
+    #   Defaults to "L%i".
+    #
+    # @param line_class [String] CSS class to use on a line wrapper element.
+    #   Defaults to "line".
+    #
+    def initialize(parent: ::Rouge::Formatters::HTML.new,
+                   highlight_lines: [],
+                   highlight_class: 'highlighted',
+                   line_id: 'L%i',
+                   line_class: 'line', **)
+      @parent = parent
+      @highlight_lines = highlight_lines
+      @highlight_class = highlight_class
+      @line_id = line_id
+      @line_class = line_class
+    end
+
+    def stream(tokens)
+      lno = 1
+      token_lines(tokens) do |line|
+        highlighted = @highlight_lines.include?(lno)
+
+        yield "\n" if lno > 1
+        yield line_open(lno)
+        yield highlight_open if highlighted
+
+        line.each do |token, value|
+          yield @parent.span(token, value)
+        end
+
+        yield highlight_close if highlighted
+        yield line_close
+
+        lno += 1
+      end
+    end
+
+    protected
+
+    def line_open(lno)
+      %(<span id=#{sprintf(@line_id, lno).inspect} class=#{@line_class.inspect}>)
+    end
+
+    def line_close
+      %(</span>)
+    end
+
+    def highlight_open
+      %(<strong class=#{@highlight_class.inspect}>)
+    end
+
+    def highlight_close
+      %(</strong>)
+    end
+  end
+end

data/lib/asciidoctor/rouge/passthroughs_substitutor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require 'asciidoctor/substitutors'
+require 'asciidoctor/rouge/version'
+
+module Asciidoctor::Rouge
+  # A substitutor for processing passthroughs inside listing blocks.
+  # It's basically just a facade for Asciidoctor's internal methods.
+  class PassthroughsSubstitutor
+
+    PASS_START_MARK = ::Asciidoctor::Substitutors::PASS_START
+    PASS_END_MARK = ::Asciidoctor::Substitutors::PASS_END
+    PASS_SLOT_RX = ::Asciidoctor::Substitutors::HighlightedPassSlotRx
+
+    # @param node [Asciidoctor::AbstractNode]
+    # @return [PassthroughsSubstitutor] a passthroughs substitutor for
+    #   the given _node_.
+    def self.create(node)
+      new(node)
+    end
+
+    # Extracts passthrough regions from the given text for reinsertion
+    # after processing.
+    #
+    # @param text [String] the source of the node.
+    # @return [String] a copy of the _text_ with passthrough regions
+    #   substituted with placeholders.
+    def extract(text)
+      @node.extract_passthroughs(text)
+    end
+
+    # Restores the extracted passthroughs by reinserting them into the
+    # placeholder positions.
+    #
+    # @param text [String] the text into which to restore the passthroughs.
+    # @return [String] a copy of the _text_ with restored passthroughs.
+    def restore(text)
+      return text if @node.passthroughs.empty?
+
+      # Fix passthrough placeholders that got caught up in syntax highlighting.
+      text = text.gsub(PASS_SLOT_RX, "#{PASS_START_MARK}\\1#{PASS_END_MARK}")
+
+      # Restore converted passthroughs.
+      @node.restore_passthroughs(text)
+    end
+
+    protected
+
+    # (see .create)
+    def initialize(node)
+      @node = node
+    end
+  end
+end

data/lib/asciidoctor/rouge/treeprocessor.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/callouts_substitutor'
+require 'asciidoctor/rouge/html_formatter'
+require 'asciidoctor/rouge/passthroughs_substitutor'
+require 'asciidoctor/extensions'
+require 'rouge'
+
+module Asciidoctor::Rouge
+  # An Asciidoctor extension that highlights source listings using Rouge.
+  class Treeprocessor < ::Asciidoctor::Extensions::Treeprocessor
+
+    # @param formatter [Class<Rouge::Formatter>] the Rouge formatter to use for
+    #   formatting a token stream from a Rouge lexer. It must respond to method
+    #   +format+ accepting a token stream and (optionally) a hash of options,
+    #   producing +String+. Defaults to {HtmlFormatter}.
+    #
+    # @param formatter_opts [Hash] options to pass to the _formatter_.
+    #   It's used only if _formatter's_ +format+ method has arity > 1.
+    #   Defaults to empty hash.
+    #
+    # @param callouts_sub [#create] the callouts substitutor class to use for
+    #   processing callouts. Defaults to {CalloutsSubstitutor}.
+    #
+    # @param passthroughs_sub [#create] the passthroughs substitutor class to
+    #   use for processing passthroughs.
+    #   Defaults to {PassthroughsSubstitutor}.
+    #
+    def initialize(formatter: HtmlFormatter,
+                   formatter_opts: {},
+                   callouts_sub: CalloutsSubstitutor,
+                   passthroughs_sub: PassthroughsSubstitutor, **)
+      super
+
+      @formatter = formatter
+      @formatter_opts = formatter_opts
+      @callouts_sub = callouts_sub
+      @passthroughs_sub = passthroughs_sub
+    end
+
+    # @param document [Asciidoctor::Document] the document to process.
+    def process(document)
+      return unless document.attr? 'source-highlighter', 'rouge'
+
+      document.find_by(context: :listing, style: 'source') do |block|
+        process_listing(block)
+      end
+    end
+
+    protected
+
+    # @param block [Asciidoctor::Block] the listing block to highlight.
+    def process_listing(block)
+      source = block.source  # String
+      subs = block.subs  # Array<Symbol>
+
+      # Don't escape special characters, Rouge will take care of it.
+      subs.delete(:specialcharacters)
+
+      if subs.delete(:macros)
+        passthroughs = @passthroughs_sub.create(block)
+        source = passthroughs.extract(source)
+      end
+
+      if subs.delete(:callouts)
+        callouts = @callouts_sub.create(block)
+        source = callouts.extract(source)
+      end
+
+      source = block.apply_subs(source, subs)
+      subs.clear
+
+      lang = block.attr('language', 'plaintext', false)
+      lexer = find_lexer(lang)
+      block.set_attr('language', lexer.tag)
+
+      if block.attr?('highlight', nil, false)
+        highlight_lines = block.resolve_highlight_lines(block.attr('highlight', '', false))
+      end
+
+      result = highlight(lexer, source, highlight_lines)
+      result = callouts.restore(result) if callouts
+      result = passthroughs.restore(result) if passthroughs
+
+      block.lines.replace(result.split("\n"))
+    end
+
+    # @param language [String]
+    # @return [Rouge::Lexer] a lexer for the specified _language_.
+    def find_lexer(language)
+      (::Rouge::Lexer.find(language) || ::Rouge::Lexers::PlainText).new
+    end
+
+    # @param lexer [Rouge::Lexer] the lexer to use.
+    # @param source [String] the code to highlight.
+    # @param highlight_lines [Array<Integer>] a list of line numbers (1-based)
+    #   to be highlighted.
+    # @return [String] a highlighted and formatted _source_.
+    def highlight(lexer, source, highlight_lines = [])
+      tokens = lexer.lex(source)
+
+      if @formatter.method(:format).arity.abs > 1
+        opts = @formatter_opts.merge(highlight_lines: highlight_lines || [])
+        @formatter.format(tokens, opts)
+      else
+        @Formatter.format(tokens)
+      end
+    end
+  end
+end

data/lib/asciidoctor/rouge/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Rouge
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-rouge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Jirutka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: corefines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email: jakub@jirutka.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- asciidoctor-rouge.gemspec
+- lib/asciidoctor-rouge.rb
+- lib/asciidoctor/rouge.rb
+- lib/asciidoctor/rouge/callouts_substitutor.rb
+- lib/asciidoctor/rouge/docinfo_processor.rb
+- lib/asciidoctor/rouge/html_formatter.rb
+- lib/asciidoctor/rouge/passthroughs_substitutor.rb
+- lib/asciidoctor/rouge/treeprocessor.rb
+- lib/asciidoctor/rouge/version.rb
+homepage: https://github.com/jirutka/asciidoctor-rouge
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Rouge code highlighter support for Asciidoctor
+test_files: []