rouge 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43af1a1e5d2fd440ddbf1af42fd151b777d8cd66ccbe9cb20f194979d51bb71
-  data.tar.gz: b36cab6b9546c3c99a8fe8bc7827b7f337d036a42c64f830db2755fcbb06adf2
+  metadata.gz: '0978a751e99189848662ab1f4d6b3763ff4ffc6bafa51d53f74a5f7d085492f5'
+  data.tar.gz: 06b154a4db8264d688c8a279c04ca6d82f8f188ae184b75a4b75df8726af3b28
 SHA512:
-  metadata.gz: 977f2c375741b0e95e545c5ce28e9fb25411036475a1fc9e102b758ae334de47511742bce87c6f53ab51f459da5dd27bf3dfba7fe14fffdbf37888283b0cc5aa
-  data.tar.gz: 0e8d5b32d0fd8a1d25ea4238ac89c7e85be5b628b6938e0e66e509e03c42fd95d159d50c9199c14534e8bb57d89198e41065f7adc8a59ec365cea4e80dd5e04e
+  metadata.gz: 1296057ef9206c038ba0da5a2c06e7e9658c95ece00bc98e8b5e22d53865930fd132ea5c3bbb9eaf6d1590c38b4680e9a83e5a7101e6a4ad5aab1be4910f01d2
+  data.tar.gz: 34acb9f469772310659845294d8fd3adfe989102cc6533a9632e64f41f1f20ad42f2e3951a0377ce8380b83b3a886178829c70868df987eb7f16f02b5f131272

data/lib/rouge.rb

@@ -69,6 +69,7 @@ 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'

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,6 +304,7 @@ 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

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/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/guessers/modeline.rb

@@ -37,7 +37,7 @@ module Rouge
 
         matches = MODELINES.map { |re| re.match(search_space) }.compact
         return lexers unless matches.any?
-        
+
         match_set = Set.new(matches.map { |m| m[1] })
         lexers.select { |l| match_set.include?(l.tag) || l.aliases.any? { |a| match_set.include?(a) } }
       end

data/lib/rouge/lexers/apache.rb

@@ -50,7 +50,7 @@ module Rouge
 
       state :section do
         # Match section arguments
-        rule %r/([^>]+)?(>(?:\r\n?|\n)?)/ do |m|
+        rule %r/([^>]+)?(>(?:\r\n?|\n)?)/ do
           groups Literal::String::Regex, Punctuation
           pop!
         end

data/lib/rouge/lexers/bpf.rb

@@ -18,25 +18,25 @@ module Rouge
 
       state :root do
         # Calls to helpers
-        rule %r/(call)(\s+)(\d+)/i do |m|
+        rule %r/(call)(\s+)(\d+)/i do
           groups Keyword, Text::Whitespace, Literal::Number::Integer
         end
 
         # Unconditional jumps
-        rule %r/(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do |m|
+        rule %r/(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do
           groups Keyword, Text::Whitespace, Literal::Number::Integer, Text::Whitespace, Name::Label
         end
 
         # Conditional jumps
-        rule %r/(if)(\s+)(r\d+)(\s*)([s!=<>]+)(\s*)(0x\h+|[-]?\d+)(\s*)(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do |m|
+        rule %r/(if)(\s+)(r\d+)(\s*)([s!=<>]+)(\s*)(0x\h+|[-]?\d+)(\s*)(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do
           groups Keyword, Text::Whitespace, Name, Text::Whitespace, Operator, Text::Whitespace, Literal::Number, Text::Whitespace, Keyword, Text::Whitespace, Literal::Number::Integer, Text::Whitespace, Name::Label
         end
-        rule %r/(if)(\s+)(r\d+)(\s*)([s!=<>]+)(\s*)(r\d+)(\s*)(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do |m|
+        rule %r/(if)(\s+)(r\d+)(\s*)([s!=<>]+)(\s*)(r\d+)(\s*)(goto)(\s*)(\+\d+)?(\s*)(<?\w+>?)/i do
           groups Keyword, Text::Whitespace, Name, Text::Whitespace, Operator, Text::Whitespace, Name, Text::Whitespace, Keyword, Text::Whitespace, Literal::Number::Integer, Text::Whitespace, Name::Label
         end
 
         # Dereferences
-        rule %r/(\*)(\s*)(\()(#{TYPE_KEYWORDS})(\s*)(\*)(\))/i do |m|
+        rule %r/(\*)(\s*)(\()(#{TYPE_KEYWORDS})(\s*)(\*)(\))/i do
           groups Operator, Text::Whitespace, Punctuation, Keyword::Type, Text::Whitespace, Operator, Punctuation
           push :address
         end
@@ -45,7 +45,7 @@ module Rouge
         rule %r/[+-\/\*&|><^s]{0,3}=/i, Operator
 
         # Registers
-        rule %r/([+-]?)(r\d+)/i do |m|
+        rule %r/([+-]?)(r\d+)/i do
           groups Punctuation, Name
         end
 
@@ -56,15 +56,15 @@ module Rouge
         rule %r/#{MISC_KEYWORDS}/i, Keyword
 
         # Literals and global objects (maps) refered by name
-        rule %r/(0x\h+|[-]?\d+)(\s*)(ll)?/i do |m|
+        rule %r/(0x\h+|[-]?\d+)(\s*)(ll)?/i do
           groups Literal::Number, Text::Whitespace, Keyword::Type
         end
-        rule %r/(\w+)(\s*)(ll)/i do |m|
+        rule %r/(\w+)(\s*)(ll)/i do
           groups Name, Text::Whitespace, Keyword::Type
         end
 
         # Labels
-        rule %r/(\w+)(\s*)(:)/i do |m|
+        rule %r/(\w+)(\s*)(:)/i do
           groups Name::Label, Text::Whitespace, Punctuation
         end
 
@@ -73,17 +73,17 @@ module Rouge
 
       state :address do
         # Address is offset from register
-        rule %r/(\()(r\d+)(\s*)([+-])(\s*)(\d+)(\))/i do |m|
+        rule %r/(\()(r\d+)(\s*)([+-])(\s*)(\d+)(\))/i do
           groups Punctuation, Name, Text::Whitespace, Operator, Text::Whitespace, Literal::Number::Integer, Punctuation
           pop!
         end
 
         # Address is array subscript
-        rule %r/(\w+)(\[)(\d+)(\])/i do |m|
+        rule %r/(\w+)(\[)(\d+)(\])/i do
           groups Name, Punctuation, Literal::Number::Integer, Punctuation
           pop!
         end
-        rule %r/(\w+)(\[)(r\d+)(\])/i do |m|
+        rule %r/(\w+)(\[)(r\d+)(\])/i do
           groups Name, Punctuation, Name, Punctuation
           pop!
         end

data/lib/rouge/lexers/ceylon.rb

@@ -31,14 +31,14 @@ module Rouge
         rule %r((abstracts|extends|satisfies|super|given|of|out|assign)\b), Keyword::Declaration
 
         rule %r((function|value|void|new)\b), Keyword::Type
-        
+
         rule %r((assembly|module|package)(\s+)) do
           groups Keyword::Namespace, Text
           push :import
         end
-        
+
         rule %r((true|false|null)\b), Keyword::Constant
-        
+
         rule %r((class|interface|object|alias)(\s+)) do
           groups Keyword::Declaration, Text
           push :class
@@ -48,7 +48,7 @@ module Rouge
           groups Keyword::Namespace, Text
           push :import
         end
-        
+
         rule %r("(\\\\|\\"|[^"])*"), Literal::String
         rule %r('\\.'|'[^\\]'|'\\\{#[0-9a-fA-F]{4}\}'), Literal::String::Char
         rule %r(".*``.*``.*"', String::Interpol
@@ -84,7 +84,7 @@ module Rouge
         rule %r([a-z][\w.]*), Name::Namespace, :pop!
         rule %r("(\\\\|\\"|[^"])*"), Literal::String, :pop!
       end
-      
+
       state :comment do
         rule %r([^*/]), Comment.Multiline
         rule %r(/\*), Comment::Multiline, :push!

data/lib/rouge/lexers/docker.rb

@@ -20,11 +20,11 @@ module Rouge
       state :root do
         rule %r/\s+/, Text
 
-        rule %r/^(ONBUILD)(\s+)(#{KEYWORDS})(.*)/io do |m|
+        rule %r/^(ONBUILD)(\s+)(#{KEYWORDS})(.*)/io do
           groups Keyword, Text::Whitespace, Keyword, Str
         end
 
-        rule %r/^(#{KEYWORDS})\b(.*)/io do |m|
+        rule %r/^(#{KEYWORDS})\b(.*)/io do
           groups Keyword, Str
         end
 

data/lib/rouge/lexers/elixir.rb

@@ -38,8 +38,11 @@ module Rouge
         rule %r/[a-zA-Z_!]\w*[!\?]?/, Name
         rule %r{::|[%(){};,/\|:\\\[\]]}, Punctuation
         rule %r/@[a-zA-Z_]\w*|&\d/, Name::Variable
-        rule %r{\b(0[xX][0-9A-Fa-f]+|\d(_?\d)*(\.(?![^\d\s])
-             (_?\d)*)?([eE][-+]?\d(_?\d)*)?|0[bB][01]+)\b}x, Num
+        rule %r{\b\d(_?\d)*(\.(?![^\d\s])(_?\d)+)([eE][-+]?\d(_?\d)*)?\b}, Num::Float
+        rule %r{\b0x[0-9A-Fa-f](_?[0-9A-Fa-f])*\b}, Num::Hex
+        rule %r{\b0o[0-7](_?[0-7])*\b}, Num::Oct
+        rule %r{\b0b[01](_?[01])*\b}, Num::Bin
+        rule %r{\b\d(_?\d)*\b}, Num::Integer
 
         mixin :strings
         mixin :sigil_strings