asciidoctor-rouge 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c67c5170e4c94b6625d49dee4ff5c46edc39255e
-  data.tar.gz: 79add3dd5c89b66bf866b14a997edb53a98470b7
+  metadata.gz: 7baa8b7c49247f40e58fd422dd7fd460a543562b
+  data.tar.gz: 0b8ad27e185a07a2812fdc072c1c296631672fb7
 SHA512:
-  metadata.gz: a900bf73225718348c4d65ee6ba1e09c3f335652058a501b1d90345744038c511f63ba31f4ed46361b426362d68cc3ebf107709126e7830778c9fa3aba0f8f1b
-  data.tar.gz: c6772dec55296fa2858b1fde19221cc45ddd3fc1997ed458655ccbe8a4ab9c6737f0ec40272b8e94a94d0c135fdb2c1799fe4d9603362ac1f3bc4e118a156b9b
+  metadata.gz: 02566ec5a875e6881edbc2bc6da92cb45c320c40f9414a53d5ba4c76bfafbc23a6ee42c0ed20091598535264a09bd6b157de46dabf788dfb9971783d7c4953be
+  data.tar.gz: d69c5765a92aaad6b80765070b88370c70b8937bb6551ad13716655bae5968dd83daacd0f280dbcea1e141dee1a2e547ae7627436ce0a867b7690ee3a0eb8003

data/README.adoc

@@ -1,8 +1,8 @@
 = Asciidoctor Rouge
-:source-language: ruby
+:source-language: shell
 // custom
 :gem-name: asciidoctor-rouge
-:gem-version: 0.1.1
+:gem-version: 0.2.0
 :gh-name: jirutka/{gem-name}
 :gh-branch: master
 :codacy-id: d2ed58f5f3f949a19bab7637fe7d0bdb
@@ -27,23 +27,39 @@ This extension is highly customizable and modular.
 
 To install (or update to the latest version):
 
-[source, sh, subs="+attributes"]
+[source, subs="+attributes"]
 gem install {gem-name}
 
 or to install the latest development version:
 
-[source, sh, subs="+attributes"]
+[source, subs="+attributes"]
 gem install {gem-name} --pre
 
 
 == Usage
 
-Set attribute `source-highlighter` to `rouge`; globally or in the document.
+Assign `rouge` to the `source-highlighter` attribute in your document’s header or via command-line argument.
 
-[source, sh, subs="+attributes"]
+[source, subs="+attributes"]
 asciidoctor -r {gem-name} -a source-highlighter=rouge Example.adoc
 
 
+=== Attributes
+
+You can further customize the source block output with additional Rouge attributes:
+
+rouge-css::
+  Controls what method is used for applying CSS to the tokens.
+  Can be `class` (CSS classes) or `style` (inline styles).
+  When `class` is used, Rouge styles for the specified theme are included in an HTML header.
+  Default is `class`.
+
+rouge-theme::
+  Sets the name of the Rouge colour theme to use.
+  Look into https://github.com/jneen/rouge/tree/master/lib/rouge/themes[lib/rouge/themes] in the Rouge repository for a list of available themes.
+  Default is `github`.
+
+
 == License
 
 This project is licensed under http://opensource.org/licenses/MIT/[MIT License].

data/lib/asciidoctor/rouge/callouts_substitutor.rb

@@ -29,7 +29,7 @@ module Asciidoctor::Rouge
       escape_char = ::Asciidoctor::Substitutors::RS
       @callouts.clear
 
-      text.each_line.with_index.map { |line, ln|
+      text.each_line.with_index(1).map { |line, ln|
         line.gsub(@callout_rx) do
           match = $LAST_MATCH_INFO
           if match[1] == escape_char
@@ -43,20 +43,17 @@ module Asciidoctor::Rouge
       }.join
     end
 
-    # Converts and restores the extracted callouts for the given _text_.
+    # Converts the extracted callout markers for the specified line.
     #
-    # @param text [#each_line]
-    # @return [String] a copy of the _text_ with inserted callouts.
-    def restore(text)
-      return text if @callouts.empty?
+    # @param line_num [Integer] the line number (1-based).
+    # @return [String] converted callout markers for the _line_num_,
+    #   or an empty string if there are no callouts for that line.
+    def convert_line(line_num)
+      return '' unless @callouts.key? line_num
 
-      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
+      @callouts[line_num]
+        .map { |num| convert_callout(num) }
+        .join(' ')
     end
 
     protected
@@ -75,7 +72,7 @@ module Asciidoctor::Rouge
     end
 
     # @param number [Integer] callout number.
-    # @return [String] an HTML markup of callout with the given _number_.
+    # @return [String] an HTML markup of a callout marker with the given _number_.
     def convert_callout(number)
       ::Asciidoctor::Inline.new(@node, :callout, number, id: next_callout_id).convert
     end

data/lib/asciidoctor/rouge/html_formatter.rb

@@ -3,75 +3,104 @@ require 'asciidoctor/rouge/version'
 require 'rouge'
 
 module Asciidoctor::Rouge
-  # An HTML Rouge formatter with support for lines ID and highlighted lines.
+  # An HTML Rouge formatter for Asciidoctor with support for callouts 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 callout_markers [#[], nil] callout markers indexed by
+    #   line numbers to be inserted between the line's content and the line's
+    #   closing tag.
     #
-    # @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 highlighted_class [String] CSS class to use on a line wrapper
+    #   element for highlighted lines (see above). Defaults to "highlighted".
     #
-    # @param highlight_class [String] CSS class to use on an element wrapping
-    #   highlighted lines (see above). Defaults to "highlighted".
+    # @param highlighted_lines [Array<Integer>] a list of line numbers
+    #   (1-based) to be highlighted (i.e. added _highlighted_class_ to a line
+    #   wrapper element). Defaults to empty array.
     #
-    # @param line_id [String] format string specifying +id+ for each line.
-    #   Defaults to "L%i".
+    # @param inline_theme [String, Rouge::Theme, Class<Rouge::Theme>, nil]
+    #   the theme to use for inline styles, or +nil+ to not set inline styles
+    #   (i.e. use classes). This is ignored if _inner_ is not +nil+.
     #
-    # @param line_class [String] CSS class to use on a line wrapper element.
-    #   Defaults to "line".
+    # @param line_class [String, nil] CSS class to set on a line wrapper
+    #   element, or +nil+ to not set a class. Defaults to "line".
     #
-    def initialize(parent: ::Rouge::Formatters::HTML.new,
-                   highlight_lines: [],
-                   highlight_class: 'highlighted',
+    # @param line_id [String, nil] format string specifying +id+ for each line,
+    #   or +nil+ to omit +id+. Defaults to "L%i".
+    #
+    # @param inner [Rouge::Formatter::HTML, #span, nil] the inner HTML
+    #   formatter to delegate formatting of tokens to, or +nil+ to get
+    #   +html+ or +html_inline+ formatter from the +Rouge::Formatter+'s
+    #   registry.
+    #
+    def initialize(callout_markers: nil,
+                   highlighted_class: 'highlighted',
+                   highlighted_lines: [],
+                   inline_theme: nil,
+                   line_class: 'line',
                    line_id: 'L%i',
-                   line_class: 'line', **)
-      @parent = parent
-      @highlight_lines = highlight_lines
-      @highlight_class = highlight_class
+                   inner: nil, **)
+
+      inner ||= if inline_theme
+        ::Rouge::Formatter.find('html_inline').new(inline_theme)
+      else
+        ::Rouge::Formatter.find('html').new
+      end
+
+      @callout_markers = callout_markers || {}
+      @inner = inner
+      @highlighted_lines = highlighted_lines || []
+      @highlighted_class = highlighted_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
+    def stream(tokens, &block)
+      token_lines(tokens).with_index(1) do |line_tokens, lno|
+        stream_lines(line_tokens, lno, &block)
+      end
+    end
 
-        yield highlight_close if highlighted
-        yield line_close
+    # Formats tokens on the specified line into HTML.
+    #
+    # @param tokens [Array<Rouge::Token>] tokens on the line.
+    # @param line_nums [Integer] the line number (1-based).
+    # @yield [String] gives formatted content.
+    def stream_lines(tokens, line_num)
+      yield line_start(line_num)
 
-        lno += 1
+      tokens.each do |token, value|
+        yield @inner.span(token, value)
       end
+
+      yield line_end(line_num)
     end
 
     protected
 
-    def line_open(lno)
-      %(<span id=#{sprintf(@line_id, lno).inspect} class=#{@line_class.inspect}>)
-    end
+    def line_start(line_num)
+      classes = [
+        @line_class,
+        (@highlighted_class if highlighted? line_num),
+      ].compact.join(' ')
 
-    def line_close
-      %(</span>)
+      [
+        ("\n" if line_num > 1),
+        '<span',
+        (" id=#{sprintf(@line_id, line_num).inspect}" if @line_id),
+        (" class=#{classes.inspect}" if !classes.empty?),
+        '>',
+      ].compact.join
     end
 
-    def highlight_open
-      %(<strong class=#{@highlight_class.inspect}>)
+    def line_end(line_num)
+      %(#{@callout_markers[line_num]}</span>)
     end
 
-    def highlight_close
-      %(</strong>)
+    def highlighted?(line_num)
+      @highlighted_lines.include?(line_num)
     end
   end
 end

data/lib/asciidoctor/rouge/treeprocessor.rb

@@ -51,8 +51,10 @@ module Asciidoctor::Rouge
 
     # @param block [Asciidoctor::Block] the listing block to highlight.
     def process_listing(block)
+      document = block.document
       source = block.source  # String
       subs = block.subs  # Array<Symbol>
+      opts = {}
 
       # Don't escape special characters, Rouge will take care of it.
       subs.delete(:specialcharacters)
@@ -74,12 +76,18 @@ module Asciidoctor::Rouge
       lexer = find_lexer(lang)
       block.set_attr('language', lexer.tag)
 
+      if document.attr?('rouge-css', 'style')
+        opts[:inline_theme] = document.attr('rouge-theme', 'github')
+      end
+
       if block.attr?('highlight', nil, false)
-        highlight_lines = block.resolve_highlight_lines(block.attr('highlight', '', false))
+        highlight = block.attr('highlight', '', false)
+        opts[:highlighted_lines] = block.resolve_highlight_lines(highlight)
       end
 
-      result = highlight(lexer, source, highlight_lines)
-      result = callouts.restore(result) if callouts
+      opts[:callout_markers] = callouts.method(:convert_line) if callouts
+
+      result = highlight(source, lexer, opts)
       result = passthroughs.restore(result) if passthroughs
 
       block.lines.replace(result.split("\n"))
@@ -91,17 +99,16 @@ module Asciidoctor::Rouge
       (::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.
+    # @param lexer [Rouge::Lexer] the lexer to use.
+    # @param opts [Hash] extra options for the formatter; it will be merged
+    #   with the +formatter_opts+ (see {#initialize}).
     # @return [String] a highlighted and formatted _source_.
-    def highlight(lexer, source, highlight_lines = [])
+    def highlight(source, lexer, opts = {})
       tokens = lexer.lex(source)
 
       if @formatter.method(:format).arity.abs > 1
-        opts = @formatter_opts.merge(highlight_lines: highlight_lines || [])
-        @formatter.format(tokens, opts)
+        @formatter.format(tokens, @formatter_opts.merge(opts))
       else
         @formatter.format(tokens)
       end

data/lib/asciidoctor/rouge/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Rouge
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-rouge
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor