rouge 3.4.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b2c941a57cd61fef299dd3c106785c4b417872ec6cc1a50034cfcbbbff3187
-  data.tar.gz: 34ffb315c85b42b21e3a24a6ca0b7ea3ebbdbb8232057718da9c3cb355dbb693
+  metadata.gz: '0978a751e99189848662ab1f4d6b3763ff4ffc6bafa51d53f74a5f7d085492f5'
+  data.tar.gz: 06b154a4db8264d688c8a279c04ca6d82f8f188ae184b75a4b75df8726af3b28
 SHA512:
-  metadata.gz: 9b8c0b0109ce776e3744f03271adb71f8a486cff52c2df222eb69ece3a098aef9d7852b750629f8860007fae163274ea087208c22c821428b4a2757434a21b36
-  data.tar.gz: 291ee2e3d738fcdb181ed61b35511ad4c1dff44a90c359fe508fd23cdc939820766d662a1bba0dbbbbff1a5959f3a18ba71d87736f0ee9df8a0cbaf842528dfd
+  metadata.gz: 1296057ef9206c038ba0da5a2c06e7e9658c95ece00bc98e8b5e22d53865930fd132ea5c3bbb9eaf6d1590c38b4680e9a83e5a7101e6a4ad5aab1be4910f01d2
+  data.tar.gz: 34acb9f469772310659845294d8fd3adfe989102cc6533a9632e64f41f1f20ad42f2e3951a0377ce8380b83b3a886178829c70868df987eb7f16f02b5f131272

data/lib/rouge.rb

@@ -69,11 +69,14 @@ load_relative 'rouge/formatters/html_table'
 load_relative 'rouge/formatters/html_pygments'
 load_relative 'rouge/formatters/html_legacy'
 load_relative 'rouge/formatters/html_linewise'
+load_relative 'rouge/formatters/html_line_table'
 load_relative 'rouge/formatters/html_inline'
 load_relative 'rouge/formatters/terminal256'
+load_relative 'rouge/formatters/tex'
 load_relative 'rouge/formatters/null'
 
 load_relative 'rouge/theme'
+load_relative 'rouge/tex_theme_renderer'
 load_relative 'rouge/themes/thankful_eyes'
 load_relative 'rouge/themes/colorful'
 load_relative 'rouge/themes/base16'
@@ -86,3 +89,4 @@ load_relative 'rouge/themes/gruvbox'
 load_relative 'rouge/themes/tulip'
 load_relative 'rouge/themes/pastie'
 load_relative 'rouge/themes/bw'
+load_relative 'rouge/themes/magritte'

data/lib/rouge/cli.rb

@@ -38,7 +38,7 @@ module Rouge
     def self.doc
       return enum_for(:doc) unless block_given?
 
-      yield %|usage: rougify [command] [args...]|
+      yield %|usage: rougify {global options} [command] [args...]|
       yield %||
       yield %|where <command> is one of:|
       yield %|	highlight	#{Highlight.desc}|
@@ -48,6 +48,9 @@ module Rouge
       yield %|	guess		#{Guess.desc}|
       yield %|	version		#{Version.desc}|
       yield %||
+      yield %|global options:|
+      yield %[	--require|-r <fname>	require <fname> after loading rouge]
+      yield %||
       yield %|See `rougify help <command>` for more info.|
     end
 
@@ -62,18 +65,22 @@ module Rouge
     def self.parse(argv=ARGV)
       argv = normalize_syntax(argv)
 
-      mode = argv.shift
+      while (head = argv.shift)
+        case head
+        when '-h', '--help', 'help', '-help'
+          return Help.parse(argv)
+        when '--require', '-r'
+          require argv.shift
+        else
+          break
+        end
+      end
 
-      klass = class_from_arg(mode)
+      klass = class_from_arg(head)
       return klass.parse(argv) if klass
 
-      case mode
-      when '-h', '--help', 'help', '-help', nil
-        Help.parse(argv)
-      else
-        argv.unshift(mode) if mode
-        Highlight.parse(argv)
-      end
+      argv.unshift(head) if head
+      Highlight.parse(argv)
     end
 
     def initialize(options={})
@@ -91,7 +98,7 @@ module Rouge
       case arg
       when 'version', '--version', '-v'
         Version
-      when 'help'
+      when 'help', nil
         Help
       when 'highlight', 'hi'
         Highlight
@@ -297,8 +304,10 @@ module Rouge
         when 'html' then Formatters::HTML.new
         when 'html-pygments' then Formatters::HTMLPygments.new(Formatters::HTML.new, opts[:css_class])
         when 'html-inline' then Formatters::HTMLInline.new(theme)
+        when 'html-line-table' then Formatters::HTMLLineTable.new(Formatters::HTML.new)
         when 'html-table' then Formatters::HTMLTable.new(Formatters::HTML.new)
         when 'null', 'raw', 'tokens' then Formatters::Null.new
+        when 'tex' then Formatters::Tex.new
         else
           error! "unknown formatter preset #{opts[:formatter]}"
         end
@@ -334,18 +343,30 @@ module Rouge
         yield %|respectively. Theme defaults to thankful_eyes.|
         yield %||
         yield %|options:|
-        yield %|  --scope	(default: .highlight) a css selector to scope by|
+        yield %|  --scope     	(default: .highlight) a css selector to scope by|
+        yield %|  --tex       	(default: false) render as TeX|
+        yield %|  --tex-prefix	(default: RG) a command prefix for TeX|
+        yield %|              	implies --tex if specified|
         yield %||
         yield %|available themes:|
         yield %|  #{Theme.registry.keys.sort.join(', ')}|
       end
 
       def self.parse(argv)
-        opts = { :theme_name => 'thankful_eyes' }
+        opts = {
+          :theme_name => 'thankful_eyes',
+          :tex => false,
+          :tex_prefix => 'RG'
+        }
 
         until argv.empty?
           arg = argv.shift
           case arg
+          when '--tex'
+            opts[:tex] = true
+          when '--tex-prefix'
+            opts[:tex] = true
+            opts[:tex_prefix] = argv.shift
           when /--(\w+)/
             opts[$1.tr('-', '_').to_sym] = argv.shift
           else
@@ -362,6 +383,10 @@ module Rouge
           or error! "unknown theme: #{theme_name}"
 
         @theme = theme_class.new(opts)
+        if opts[:tex]
+          tex_prefix = opts[:tex_prefix]
+          @theme = TexThemeRenderer.new(@theme, prefix: tex_prefix)
+        end
       end
 
       def run

data/lib/rouge/demos/bpf

@@ -0,0 +1,7 @@
+r0 = *(u8 *)skb[23]
+*(u32 *)(r10 - 4) = r0
+r1 = *(u32 *)(r6 + 4)
+r1 = 0 ll
+call 1	/* lookup */
+if r0 == 0 goto +2 <LBB0_3>
+lock *(u64 *)(r0 + 0) += r1

data/lib/rouge/demos/brainfuck

@@ -0,0 +1,5 @@
+[
+	This is a sample
+	comment.
+]
+.[>+<-]>,

data/lib/rouge/demos/magik

@@ -0,0 +1,6 @@
+_private _method test_object.init()
+	## initializer
+	.slot1 << _self.default_value
+	_return _self
+_endmethod
+$

data/lib/rouge/demos/openedge

@@ -0,0 +1,4 @@
+FORM
+    "Hello World!" VIEW-AS TEXT AT COL 20 ROW 2
+    btnOK AT COL 20 ROW 4
+    WITH FRAME f SIZE 50 BY 5 NO-BOX THREE-D.

data/lib/rouge/demos/powershell

@@ -1,49 +1,13 @@
-Function Get-IPv4Scopes
-<#
-	.SYNOPSIS
-		Read IPv4Scopes from an array of servers
-	.PARAMETER Servers
-		Specifies an array of servers
-	.EXAMPLE
-		Get-IPv4Scopes
-        
-		Will prompt for all inputs
-#>
+function Verb-Noun
 {
-    [CmdletBinding()]
-    Param(
-    # 1
-    [parameter(
-        Mandatory=$true,
-        Position=0,
-        ValueFromPipelineByPropertyName=$true,
-        HelpMessage="Server List"
-        )]
-    [string[]]$Servers,
-    #2
-    [parameter(Mandatory=$false,ValueFromPipeline=$false)]
-    [bool]$Unique=$false
-    )  #EndParam
-
-    Begin {}
-
-    Process {
-        $arrayJobs=@()
-        foreach ($server in $Servers) {
-            $arrayJobs+=Invoke-Command -ComputerName $server -scriptblock {Get-DhcpServerv4Scope}  -AsJob
-        }
-        $complete=$false
-        while (-not $complete) {
-            $arrayJobsInProgress= $arrayJobs | Where-Object { $_.State -match 'running' }
-            if (-not $arrayJobsInProgress) { $complete=$true }
-        }
-        $Scopes=$arrayJobs|Receive-Job
-        $UniqueScopes=$Scopes|Sort-Object -Property ScopeId -Unique
-    }
-
-    End {
-        if ($Unique) { return $UniqueScopes }
-        else { return $Scopes }
-    }
-
-} #end function
+    <#
+    .SYNOPSIS
+    Tells you what it does
+
+    .DESCRIPTION
+    Tells you what it does with more detail.
+    #>
+    param ([string]$Name, [string]$Extension = "txt", [string]$foo="bar")
+    $name = $name + "." + $extension
+    $name
+}

data/lib/rouge/demos/xojo

@@ -1,7 +1,8 @@
 Dim f As FolderItem
 f = GetOpenFolderItem(FileTypes1.jpeg) // defined in the File Type Set editor
+rem - we should check for nil!
 If not f.Exists Then
-  Beep
+  Beep 'Just for fun
   MsgBox("The file " + f.NativePath + "doesn't ""exist.""")
 Else // document exists
   ImageWell1.image=Picture.Open(f)

data/lib/rouge/demos/xpath

@@ -0,0 +1,2 @@
+(: Authors named Bob Joe who didn't graduate from Harvard :)
+//author[first-name = "Joe" and last-name = "Bob"][degree/@from != "Harvard"]

data/lib/rouge/demos/xquery

@@ -0,0 +1,22 @@
+declare namespace html = "http://www.w3.org/1999/xhtml";
+
+declare function local:test-function($catalog as document-node()) {
+  <html>
+    <head>
+      <title>XQuery example for the Rouge highlighter</title>
+      <link href="style.css"/>
+    </head>
+    <body>
+      <h1>List</h1>
+      <ul>
+        {for $product in $catalog/items/product[@sell-by > current-date()] return
+        <li>
+          <ul>
+            <li>{data($product/name)}</li>
+            <li>{$product/price * (1 + $product/tax)}$</li>
+          </ul>
+        </li>}
+      </ul>
+    </body>
+  </html>
+};

data/lib/rouge/formatter.rb

@@ -29,7 +29,7 @@ module Rouge
     end
 
     def self.escape_enabled?
-      !!(@escape_enabled || Thread.current[:'rouge/with-escape'])
+      !!(((defined? @escape_enabled) && @escape_enabled) || Thread.current[:'rouge/with-escape'])
     end
 
     def self.enable_escape!
@@ -94,7 +94,7 @@ module Rouge
 
       out = []
       tokens.each do |tok, val|
-        val.scan /\n|[^\n]+/ do |s|
+        val.scan %r/\n|[^\n]+/ do |s|
           if s == "\n"
             yield out
             out = []

data/lib/rouge/formatters/html.rb

@@ -15,7 +15,7 @@ module Rouge
       def span(tok, val)
         return val if escape?(tok)
 
-        safe_span(tok, val.gsub(/[&<>]/, TABLE_FOR_ESCAPE_HTML))
+        safe_span(tok, escape_special_html_chars(val))
       end
 
       def safe_span(tok, safe_val)
@@ -29,12 +29,28 @@ module Rouge
         end
       end
 
-
       TABLE_FOR_ESCAPE_HTML = {
         '&' => '&amp;',
         '<' => '&lt;',
         '>' => '&gt;',
       }
+
+    private
+      # A performance-oriented helper method to escape `&`, `<` and `>` for the rendered
+      # HTML from this formatter.
+      #
+      # `String#gsub` will always return a new string instance irrespective of whether
+      # a substitution occurs. This method however invokes `String#gsub` only if
+      # a substitution is imminent.
+      #
+      # Returns either the given `value` argument string as is or a new string with the
+      # special characters replaced with their escaped counterparts.
+      def escape_special_html_chars(value)
+        escape_regex = /[&<>]/
+        return value unless value =~ escape_regex
+
+        value.gsub(escape_regex, TABLE_FOR_ESCAPE_HTML)
+      end
     end
   end
 end

data/lib/rouge/formatters/html_line_table.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+module Rouge
+  module Formatters
+    class HTMLLineTable < Formatter
+      tag 'html_line_table'
+
+      # @param [Rouge::Formatters::Formatter] formatter An instance of a
+      #   `Rouge::Formatters::HTML` or `Rouge::Formatters::HTMLInline`
+      # @param [Hash] opts options for HTMLLineTable instance.
+      # @option opts [Integer] :start_line line number to start from. Defaults to `1`.
+      # @option opts [String] :table_class Class name for the table.
+      #   Defaults to `"rouge-line-table"`.
+      # @option opts [String] :line_id  a `sprintf` template for generating an `id`
+      #   attribute for each table row corresponding to current line number.
+      #   Defaults to `"line-%i"`.
+      # @option opts [String] :line_class Class name for each table row.
+      #   Defaults to `"lineno"`.
+      # @option opts [String] :gutter_class Class name for rendered line-number cell.
+      #   Defaults to `"rouge-gutter"`.
+      # @option opts [String] :code_class Class name for rendered code cell.
+      #   Defaults to `"rouge-code"`.
+      def initialize(formatter, opts={})
+        @formatter    = formatter
+        @start_line   = opts.fetch :start_line,   1
+        @table_class  = opts.fetch :table_class,  'rouge-line-table'
+        @gutter_class = opts.fetch :gutter_class, 'rouge-gutter'
+        @code_class   = opts.fetch :code_class,   'rouge-code'
+        @line_class   = opts.fetch :line_class,   'lineno'
+        @line_id      = opts.fetch :line_id,      'line-%i'
+      end
+
+      def stream(tokens, &b)
+        lineno = @start_line - 1
+        buffer = [%(<table class="#@table_class"><tbody>)]
+        token_lines(tokens) do |line_tokens|
+          lineno += 1
+          buffer << %(<tr id="#{sprintf @line_id, lineno}" class="#@line_class">)
+          buffer << %(<td class="#@gutter_class gl">)
+          buffer << %(<pre>#{lineno}</pre></td>)
+          buffer << %(<td class="#@code_class"><pre>)
+          @formatter.stream(line_tokens) { |formatted| buffer << formatted }
+          buffer << "\n</pre></td></tr>"
+        end
+        buffer << %(</tbody></table>)
+        yield buffer.join
+      end
+    end
+  end
+end

data/lib/rouge/formatters/tex.rb

@@ -0,0 +1,90 @@
+module Rouge
+  module Formatters
+    class Tex < Formatter
+      tag 'tex'
+
+      # A map of TeX escape characters.
+      # Newlines are handled specially by using #token_lines
+      # spaces are preserved as long as they aren't at the beginning
+      # of a line. see #tag_first for our initial-space strategy
+      ESCAPE = {
+        '&' => '\&',
+        '%' => '\%',
+        '$' => '\$',
+        '#' => '\#',
+        '_' => '\_',
+        '{' => '\{',
+        '}' => '\}',
+        '~' => '{\textasciitilde}',
+        '^' => '{\textasciicircum}',
+        '|' => '{\textbar}',
+        '\\' => '{\textbackslash}',
+        "\t" => '{\tab}',
+      }
+
+      ESCAPE_REGEX = /[#{ESCAPE.keys.map(&Regexp.method(:escape)).join}]/om
+
+      def initialize(opts={})
+        @prefix = opts.fetch(:prefix) { 'RG' }
+      end
+
+      def escape_tex(str)
+        str.gsub(ESCAPE_REGEX, ESCAPE)
+      end
+
+      def stream(tokens, &b)
+        # surround the output with \begin{RG*}...\end{RG*}
+        yield "\\begin{#{@prefix}*}%\n"
+
+        # we strip the newline off the last line to avoid
+        # an extra line being rendered. we do this by yielding
+        # the \newline tag *before* every line group except
+        # the first.
+        first = true
+
+        token_lines tokens do |line|
+          if first
+            first = false
+          else
+            yield "\\newline%\n"
+          end
+
+          render_line(line, &b)
+        end
+
+        yield "%\n\\end{#{@prefix}*}%\n"
+      end
+
+      def render_line(line, &b)
+        head, *rest = line
+        return unless head
+
+        tag_first(*head, &b)
+        rest.each do |(tok, val)|
+          yield tag(tok, val)
+        end
+      end
+
+      # special handling for the first token
+      # of a line. we replace all initial spaces
+      # with \hphantom{xxxx}, which renders an
+      # empty space equal to the size of the x's.
+      def tag_first(tok, val)
+        leading = nil
+        val.sub!(/^[ ]+/) { leading = $&.size; '' }
+        yield "\\hphantom{#{'x' * leading}}" if leading
+        yield tag(tok, val)
+      end
+
+      def tag(tok, val)
+        if escape?(tok)
+          val
+        elsif tok == Token::Tokens::Text
+          escape_tex(val)
+        else
+          "\\#@prefix{#{tok.shortname}}{#{escape_tex(val)}}"
+        end
+      end
+    end
+  end
+end