asciidoctor-rouge 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7baa8b7c49247f40e58fd422dd7fd460a543562b
-  data.tar.gz: 0b8ad27e185a07a2812fdc072c1c296631672fb7
+SHA256:
+  metadata.gz: f17d5f09f366075fcf74b6c8a78c5d63d3ae5a5b75955ef5472b7720a77dcc42
+  data.tar.gz: a5c4a90b5cc7d94c1484218bd6d6141a0507e2700f4e9496211f4677bdf37b14
 SHA512:
-  metadata.gz: 02566ec5a875e6881edbc2bc6da92cb45c320c40f9414a53d5ba4c76bfafbc23a6ee42c0ed20091598535264a09bd6b157de46dabf788dfb9971783d7c4953be
-  data.tar.gz: d69c5765a92aaad6b80765070b88370c70b8937bb6551ad13716655bae5968dd83daacd0f280dbcea1e141dee1a2e547ae7627436ce0a867b7690ee3a0eb8003
+  metadata.gz: 0bde3c8cf4e5fdeaea5a06d36464b3d64bb372f18cdc93da8539632265022c69a6f44d7e0ef90a3e710ae736299ccce4d669cc715181a68cedb41f4d6f988796
+  data.tar.gz: caaae8119525e79da84ec7c072bed0a35bf34196feb95f7efa0b619317d9b6340b9b7d81b1bd264b1e66ad0c0b95df499560e4d394de2c1b94b6084b1d1cd5e8

data/README.adoc

@@ -2,7 +2,7 @@
 :source-language: shell
 // custom
 :gem-name: asciidoctor-rouge
-:gem-version: 0.2.0
+:gem-version: 0.3.0
 :gh-name: jirutka/{gem-name}
 :gh-branch: master
 :codacy-id: d2ed58f5f3f949a19bab7637fe7d0bdb
@@ -59,6 +59,9 @@ rouge-theme::
   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`.
 
+rouge-style::
+  Alternative name for the `rouge-theme` for compatibility with _asciidoctor-pdf_ (see https://github.com/{gh-name}/issues/3[#3]).
+
 
 == License
 

data/asciidoctor-rouge.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rouge', '~> 2.2'
 
   s.add_development_dependency 'corefines', '~> 1.11'
+  s.add_development_dependency 'kramdown', '~> 1.16'
   s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'rspec', '~> 3.6'
   s.add_development_dependency 'rubocop', '~> 0.49.0'

data/lib/asciidoctor/rouge.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require 'asciidoctor/extensions'
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 require 'asciidoctor/rouge/docinfo_processor'
 require 'asciidoctor/rouge/treeprocessor'
 

data/lib/asciidoctor/rouge/callouts_substitutor.rb

@@ -3,7 +3,7 @@ require 'English'
 require 'asciidoctor'
 require 'asciidoctor/inline'
 require 'asciidoctor/substitutors'
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 
 module Asciidoctor::Rouge
   # A substitutor for processing callouts inside a source listing block.
@@ -13,18 +13,18 @@ module Asciidoctor::Rouge
     attr_reader :callouts
 
     # @param node [Asciidoctor::AbstractNode]
-    # @return [CalloutsSubstitutor] a callouts substitutor for the given _node_.
+    # @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
+    # 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.
+    # @return [String] a copy of the *text* with callout marks removed.
     def extract(text)
       escape_char = ::Asciidoctor::Substitutors::RS
       @callouts.clear
@@ -72,7 +72,7 @@ module Asciidoctor::Rouge
     end
 
     # @param number [Integer] callout number.
-    # @return [String] an HTML markup of a callout marker 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/constants.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'asciidoctor/rouge/version'
+
+module Asciidoctor
+  module Rouge
+    # Name of the default Rouge theme (style) to use when `rouge-theme` attribute
+    # is not specified.
+    DEFAULT_THEME = 'github'.freeze
+  end
+end

data/lib/asciidoctor/rouge/docinfo_processor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 require 'asciidoctor/extensions'
 require 'rouge'
 
@@ -13,7 +13,7 @@ module Asciidoctor::Rouge
       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')))
+      if (theme = ::Rouge::Theme.find(document.attr('rouge-theme', DEFAULT_THEME)))
         css = theme.render(scope: '.highlight')
         ['<style>', css, '</style>'].join("\n")
       end

data/lib/asciidoctor/rouge/html_formatter.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 require 'rouge'
 
 module Asciidoctor::Rouge
@@ -21,18 +21,18 @@ module Asciidoctor::Rouge
     #   wrapper element). Defaults to empty array.
     #
     # @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+.
+    #   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, nil] CSS class to set on a line wrapper
-    #   element, or +nil+ to not set a class. Defaults to "line".
+    #   element, or `nil` to not set a class. Defaults to "line".
     #
-    # @param line_id [String, nil] format string specifying +id+ for each line,
-    #   or +nil+ to omit +id+. Defaults to "L%i".
+    # @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
+    #   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,

data/lib/asciidoctor/rouge/passthroughs_substitutor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require 'asciidoctor/substitutors'
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 
 module Asciidoctor::Rouge
   # A substitutor for processing passthroughs inside listing blocks.
@@ -13,7 +13,7 @@ module Asciidoctor::Rouge
 
     # @param node [Asciidoctor::AbstractNode]
     # @return [PassthroughsSubstitutor] a passthroughs substitutor for
-    #   the given _node_.
+    #   the given *node*.
     def self.create(node)
       new(node)
     end
@@ -22,7 +22,7 @@ module Asciidoctor::Rouge
     # after processing.
     #
     # @param text [String] the source of the node.
-    # @return [String] a copy of the _text_ with passthrough regions
+    # @return [String] a copy of the *text* with passthrough regions
     #   substituted with placeholders.
     def extract(text)
       @node.extract_passthroughs(text)
@@ -32,7 +32,7 @@ module Asciidoctor::Rouge
     # placeholder positions.
     #
     # @param text [String] the text into which to restore the passthroughs.
-    # @return [String] a copy of the _text_ with restored passthroughs.
+    # @return [String] a copy of the *text* with restored passthroughs.
     def restore(text)
       return text if @node.passthroughs.empty?
 

data/lib/asciidoctor/rouge/treeprocessor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'asciidoctor/rouge/version'
+require 'asciidoctor/rouge/constants'
 require 'asciidoctor/rouge/callouts_substitutor'
 require 'asciidoctor/rouge/html_formatter'
 require 'asciidoctor/rouge/passthroughs_substitutor'
@@ -12,11 +12,11 @@ module Asciidoctor::Rouge
 
     # @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}.
+    #   `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.
+    # @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
@@ -45,6 +45,20 @@ module Asciidoctor::Rouge
       document.find_by(context: :listing, style: 'source') do |block|
         process_listing(block)
       end
+
+      # Table cells may contain listing, but Document#find_by does not search
+      # inside table, so we must handle it specially.
+      document.find_by(context: :table) do |table|
+        table.rows.body.each do |row|
+          row.each do |cell|
+            if (inner = cell.inner_document)
+              inner.find_by(context: :listing, style: 'source') do |block|
+                process_listing(block)
+              end
+            end
+          end
+        end
+      end
     end
 
     protected
@@ -77,7 +91,11 @@ module Asciidoctor::Rouge
       block.set_attr('language', lexer.tag)
 
       if document.attr?('rouge-css', 'style')
-        opts[:inline_theme] = document.attr('rouge-theme', 'github')
+        # 'rouge-style' is alternative name for compatibility with
+        # asciidoctor-pdf (see #3).
+        opts[:inline_theme] = document.attr('rouge-theme') \
+                           || document.attr('rouge-style') \
+                           || DEFAULT_THEME
       end
 
       if block.attr?('highlight', nil, false)
@@ -94,7 +112,7 @@ module Asciidoctor::Rouge
     end
 
     # @param language [String]
-    # @return [Rouge::Lexer] a lexer for the specified _language_.
+    # @return [Rouge::Lexer] a lexer for the specified *language*.
     def find_lexer(language)
       (::Rouge::Lexer.find(language) || ::Rouge::Lexers::PlainText).new
     end
@@ -102,8 +120,8 @@ module Asciidoctor::Rouge
     # @param source [String] the code to highlight.
     # @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_.
+    #   with the `formatter_opts` (see {#initialize}).
+    # @return [String] a highlighted and formatted *source*.
     def highlight(source, lexer, opts = {})
       tokens = lexer.lex(source)
 

data/lib/asciidoctor/rouge/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-rouge
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +148,7 @@ files:
 - lib/asciidoctor-rouge.rb
 - lib/asciidoctor/rouge.rb
 - lib/asciidoctor/rouge/callouts_substitutor.rb
+- lib/asciidoctor/rouge/constants.rb
 - lib/asciidoctor/rouge/docinfo_processor.rb
 - lib/asciidoctor/rouge/html_formatter.rb
 - lib/asciidoctor/rouge/passthroughs_substitutor.rb
@@ -159,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Rouge code highlighter support for Asciidoctor