rouge 3.19.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31311a77cd2c1bbe0bd0eb402b7b5d0e08c46a91fb9ae7614310b5c022f7707c
-  data.tar.gz: daa405b54f1c0a249a57d6f5044e52a08a861aece022df92ee311492cfd6d553
+  metadata.gz: 3b4023b528780340984bedccbe7068091fe13e092ec69c43972849924928eaf0
+  data.tar.gz: 20d90c29a74768ad39ffd84202396ba17be6c67c4d91daef83c7aa11b8bf55a2
 SHA512:
-  metadata.gz: 27a79b06908ec8791d6e743817c35dae531e0b171cd35efa43190b384fbb87c74a72fbf5226b233ce8f96e57e2dc31596d91f5bb43307628c41da901544f649f
-  data.tar.gz: 2bdf4c0aa72e72944e28428ac4c5eea314b01fd3314f037f107f80e43f125471cab7dc1d82ff055337015e231495fa781c6fd0a80db2c6a702346bea915b38af
+  metadata.gz: 5ce0c09ee43cf473c4e86dcc74fa84c735cc045080a47fc46e31a40553e8e0e106069b1f8cc2c23bcf76f80a5ba9749717e47a8385e970456b035bdb9ea626aa
+  data.tar.gz: 1a54b8b602cc6bca9b1f04c9eebc5353962f6476866f04b48092ffde45511408c6fbfb096fe0b450aa55bf8922ccbb62dd61363e4d71ef198651f49a6a0dac95

data/lib/rouge.rb

@@ -83,6 +83,7 @@ Rouge.load_file 'formatters/html_table'
 Rouge.load_file 'formatters/html_pygments'
 Rouge.load_file 'formatters/html_legacy'
 Rouge.load_file 'formatters/html_linewise'
+Rouge.load_file 'formatters/html_line_highlighter'
 Rouge.load_file 'formatters/html_line_table'
 Rouge.load_file 'formatters/html_inline'
 Rouge.load_file 'formatters/terminal256'

data/lib/rouge/cli.rb

@@ -44,6 +44,7 @@ module Rouge
       yield %||
       yield %|where <command> is one of:|
       yield %|	highlight	#{Highlight.desc}|
+      yield %|	debug		#{Debug.desc}|
       yield %|	help		#{Help.desc}|
       yield %|	style		#{Style.desc}|
       yield %|	list		#{List.desc}|
@@ -104,6 +105,8 @@ module Rouge
         Help
       when 'highlight', 'hi'
         Highlight
+      when 'debug'
+        Debug
       when 'style'
         Style
       when 'list'
@@ -215,7 +218,7 @@ module Rouge
         end
       end
 
-      def self.parse(argv)
+      def self.parse_opts(argv)
         opts = {
           :formatter => supports_truecolor? ? 'terminal-truecolor' : 'terminal256',
           :theme => 'thankful_eyes',
@@ -256,7 +259,11 @@ module Rouge
           end
         end
 
-        new(opts)
+        opts
+      end
+
+      def self.parse(argv)
+        new(parse_opts(argv))
       end
 
       def input_stream
@@ -344,6 +351,29 @@ module Rouge
       end
     end
 
+    class Debug < Highlight
+      def self.desc
+      end
+
+      def self.doc
+        return enum_for(:doc) unless block_given?
+
+        yield %|usage: rougify debug [<options>]|
+        yield %||
+        yield %|Debug a lexer. Similar options to `rougify highlight`, but|
+        yield %|defaults to the `null` formatter, and ensures the `debug`|
+        yield %|option is enabled, to print debugging information to stdout.|
+      end
+
+      def self.parse_opts(argv)
+        out = super(argv)
+        out[:lexer_opts]['debug'] = '1'
+        out[:formatter] = 'null'
+
+        out
+      end
+    end
+
     class Style < CLI
       def self.desc
         "print CSS styles"

data/lib/rouge/demos/augeas

@@ -0,0 +1,16 @@
+(*
+  This is a comment
+*)
+module Foo =
+autoload xfm
+
+let a = b | c . d
+
+let lns = a*
+
+let filter = incl "/path/to/file"
+           . incl "/path/to/other_file"
+           . Util.stdexcl
+
+(* xmf is the transform *)
+let xmf = transform lns filter

data/lib/rouge/demos/bibtex

@@ -0,0 +1,12 @@
+@article{Witten:1988hf,
+      author         = "Witten, Edward",
+      title          = "{Quantum Field Theory and the Jones Polynomial}",
+      journal        = "Commun. Math. Phys.",
+      volume         = "121",
+      year           = "1989",
+      pages          = "351-399",
+      doi            = "10.1007/BF01217730",
+      note           = "[,233(1988)]",
+      reportNumber   = "IASSNS-HEP-88-33",
+      SLACcitation   = "%%CITATION = CMPHA,121,351;%%"
+}

data/lib/rouge/demos/brightscript

@@ -0,0 +1,6 @@
+function main(args as dynamic) as void
+    screen = CreateObject("roSGScreen")
+    'Create a scene and load /components/helloworld.xml'
+    scene = screen.CreateScene("HelloWorld")
+    screen.show()
+end function

data/lib/rouge/demos/email

@@ -0,0 +1,11 @@
+From: Me <me@example.com>
+To: You <you@example.com>
+Date: Tue, 21 Jul 2020 15:14:03 +0000
+Subject: A very important message
+
+> Please investigate.  Thank you.
+
+I have investigated.
+
+-- 
+This message is highly confidential and will self-destruct.

data/lib/rouge/demos/hlsl

@@ -0,0 +1,20 @@
+struct PSInput
+{
+    float4 position : SV_POSITION;
+    float4 color : COLOR;
+};
+
+// Vertex shader
+PSInput VSMain(float4 position : POSITION, float4 color : COLOR)
+{
+    PSInput result;
+    result.position = position;
+    result.color = color;
+    return result;
+}
+
+// Pixel shader
+float4 PSMain(PSInput input) : SV_TARGET
+{
+    return input.color;
+}

data/lib/rouge/demos/j

@@ -0,0 +1,12 @@
+NB. Procedural programming
+fizzbuzz=: monad define
+  for_i. >:i.y do.
+    if.     0 = 15 | i do. echo'FizzBuzz'
+    elseif. 0 =  3 | i do. echo'Fizz'
+    elseif. 0 =  5 | i do. echo'Buzz'
+    else.                  echo i
+    end.
+  end.
+)
+NB. Loopless programming
+fizzbuzz=: echo@(, ::] ('Fizz' ; 'Buzz') ;@#~ 0 = 3 5&|)@>:@i.

data/lib/rouge/demos/janet

@@ -0,0 +1,3 @@
+(defn a-fun
+  "A function"
+  (do-something))

data/lib/rouge/demos/livescript

@@ -0,0 +1,15 @@
+mitch =
+    age:    21
+    height: 180cm
+    pets:   [\dog, \goldfish]
+
+phile = {}
+phile{height, pets} = mitch
+phile.height #=> 180
+phile.pets   #=> ['dog', 'goldfish']
+
+a = [2 7 1 8]
+    ..push 3
+    ..shift!
+    ..sort!
+a #=> [1,3,7,8]

data/lib/rouge/demos/ocl

@@ -0,0 +1,4 @@
+context Compagnie::toEuros() : Collection(Real)
+body: self.employees->collect(each: Employee| each.salary/ 6.55957)
+-- OR
+body: self.employees->collect(salary) -> collect(x | x/6.55957)

data/lib/rouge/demos/postscript

@@ -0,0 +1,9 @@
+%!PS
+/Courier             % name the desired font
+20 selectfont        % choose the size in points and establish
+                     % the font as the current one
+72 500 moveto        % position the current point at
+                     % coordinates 72, 500 (the origin is at the
+                     % lower-left corner of the page)
+(Hello world!) show  % stroke the text in parentheses
+showpage             % print all on the page

data/lib/rouge/demos/rescript

@@ -0,0 +1,26 @@
+module Person = {
+  type t = Teacher | Director | Student(string)
+
+  let greeting = person =>
+    switch person {
+    | Teacher => "Hey Professor!"
+    | Director => "Hello Director."
+    | Student("Richard") => "Still here Ricky?"
+    | Student(other) => "Hey, " ++ other ++ "."
+    }
+}
+
+module Button = {
+  @react.component
+  let make = (~count: int, ~onClick) => {
+    let times = switch count {
+    | 1 => "once"
+    | 2 => "twice"
+    | n => Belt.Int.toString(n) ++ " times"
+    }
+
+    let msg = "Click me " ++ times
+
+    <button onClick> {msg->React.string} </button>
+  }
+}

data/lib/rouge/demos/ssh

@@ -0,0 +1,4 @@
+Host example
+    Hostname example.com
+    User user
+    Port 1234

data/lib/rouge/demos/systemd

@@ -0,0 +1,4 @@
+[Unit]
+Description=Snap Daemon
+Requires=snapd.socket
+OnFailure=snapd.failure.service

data/lib/rouge/demos/velocity

@@ -0,0 +1,9 @@
+#*
+ There is multi-line comment.
+ see this text because the Velocity Templating Engine will ignore it.
+*#
+<h3>List</h3>
+## This is a single line comment.
+#if( $allProducts )
+<p>not found.</p>
+#end

data/lib/rouge/demos/zig

@@ -0,0 +1,6 @@
+const std = @import("std");
+const warn = std.debug.warn;
+
+fn add_floats(x: f16, y: f16) f16 {
+    return x + y;
+}

data/lib/rouge/formatters/html_line_highlighter.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+module Rouge
+  module Formatters
+    class HTMLLineHighlighter < Formatter
+      tag 'html_line_highlighter'
+
+      def initialize(delegate, opts = {})
+        @delegate = delegate
+        @highlight_line_class = opts.fetch(:highlight_line_class, 'hll')
+        @highlight_lines = opts[:highlight_lines] || []
+      end
+
+      def stream(tokens)
+        token_lines(tokens).with_index(1) do |line_tokens, lineno|
+          line = %(#{@delegate.format(line_tokens)}\n)
+          line = %(<span class="#{@highlight_line_class}">#{line}</span>) if @highlight_lines.include? lineno
+          yield line
+        end
+      end
+    end
+  end
+end

data/lib/rouge/formatters/html_line_table.rb

@@ -32,10 +32,8 @@ module Rouge
       end
 
       def stream(tokens, &b)
-        lineno = @start_line - 1
         buffer = [%(<table class="#@table_class"><tbody>)]
-        token_lines(tokens) do |line_tokens|
-          lineno += 1
+        token_lines(tokens).with_index(@start_line) do |line_tokens, lineno|
           buffer << %(<tr id="#{sprintf @line_id, lineno}" class="#@line_class">)
           buffer << %(<td class="#@gutter_class gl" )
           buffer << %(style="-moz-user-select: none;-ms-user-select: none;)

data/lib/rouge/formatters/html_linewise.rb

@@ -11,9 +11,8 @@ module Rouge
       end
 
       def stream(tokens, &b)
-        lineno = 0
-        token_lines(tokens) do |line_tokens|
-          yield %(<#{@tag_name} class="#{sprintf @class_format, lineno += 1}">)
+        token_lines(tokens).with_index(1) do |line_tokens, lineno|
+          yield %(<#{@tag_name} class="#{sprintf @class_format, lineno}">)
           @formatter.stream(line_tokens) {|formatted| yield formatted }
           yield %(\n</#{@tag_name}>)
         end

data/lib/rouge/lexer.rb

@@ -38,28 +38,15 @@ module Rouge
         registry[name.to_s]
       end
 
-      # Find a lexer, with fancy shiny features.
-      #
-      # * The string you pass can include CGI-style options
-      #
-      #     Lexer.find_fancy('erb?parent=tex')
-      #
-      # * You can pass the special name 'guess' so we guess for you,
-      #   and you can pass a second argument of the code to guess by
-      #
-      #     Lexer.find_fancy('guess', "#!/bin/bash\necho Hello, world")
+      # Same as ::find_fancy, except instead of returning an instantiated
+      # lexer, returns a pair of [lexer_class, options], so that you can
+      # modify or provide additional options to the lexer.
       #
-      #   If the code matches more than one lexer then Guesser::Ambiguous
-      #   is raised.
-      #
-      # This is used in the Redcarpet plugin as well as Rouge's own
-      # markdown lexer for highlighting internal code blocks.
-      #
-      def find_fancy(str, code=nil, additional_options={})
-
+      # Please note: the lexer class might be nil!
+      def lookup_fancy(str, code=nil, default_options={})
         if str && !str.include?('?') && str != 'guess'
           lexer_class = find(str)
-          return lexer_class && lexer_class.new(additional_options)
+          return [lexer_class, default_options]
         end
 
         name, opts = str ? str.split('?', 2) : [nil, '']
@@ -75,7 +62,7 @@ module Rouge
           [ k.to_s, val ]
         end
 
-        opts = additional_options.merge(Hash[opts])
+        opts = default_options.merge(Hash[opts])
 
         lexer_class = case name
         when 'guess', nil
@@ -84,6 +71,29 @@ module Rouge
           self.find(name)
         end
 
+        [lexer_class, opts]
+      end
+
+      # Find a lexer, with fancy shiny features.
+      #
+      # * The string you pass can include CGI-style options
+      #
+      #     Lexer.find_fancy('erb?parent=tex')
+      #
+      # * You can pass the special name 'guess' so we guess for you,
+      #   and you can pass a second argument of the code to guess by
+      #
+      #     Lexer.find_fancy('guess', "#!/bin/bash\necho Hello, world")
+      #
+      #   If the code matches more than one lexer then Guesser::Ambiguous
+      #   is raised.
+      #
+      # This is used in the Redcarpet plugin as well as Rouge's own
+      # markdown lexer for highlighting internal code blocks.
+      #
+      def find_fancy(str, code=nil, default_options={})
+        lexer_class, opts = lookup_fancy(str, code, default_options)
+
         lexer_class && lexer_class.new(opts)
       end
 
@@ -317,6 +327,14 @@ module Rouge
       @debug = Lexer.debug_enabled? && bool_option('debug')
     end
 
+    # Returns a new lexer with the given options set. Useful for e.g. setting
+    # debug flags post hoc, or providing global overrides for certain options
+    def with(opts={})
+      new_options = @options.dup
+      opts.each { |k, v| new_options[k.to_s] = v }
+      self.class.new(new_options)
+    end
+
     def as_bool(val)
       case val
       when nil, false, 0, '0', 'false', 'off'

data/lib/rouge/lexers/apex.rb

@@ -49,7 +49,7 @@ module Rouge
 
       state :root do
         rule %r/\s+/m, Text
-        
+
         rule %r(//.*?$), Comment::Single
         rule %r(/\*.*?\*/)m, Comment::Multiline
 
@@ -57,17 +57,19 @@ module Rouge
         rule %r/import\b/, Keyword::Namespace, :import
 
         rule %r/([@$.]?)(#{id})([:(]?)/io do |m|
-          if self.class.keywords.include? m[0].downcase
+          lowercased = m[0].downcase
+          uppercased = m[0].upcase
+          if self.class.keywords.include? lowercased
             token Keyword
-          elsif self.class.soql.include? m[0].upcase
+          elsif self.class.soql.include? uppercased
             token Keyword
-          elsif self.class.declarations.include? m[0].downcase
+          elsif self.class.declarations.include? lowercased
             token Keyword::Declaration
-          elsif self.class.types.include? m[0].downcase
+          elsif self.class.types.include? lowercased
             token Keyword::Type
-          elsif self.class.constants.include? m[0].downcase
+          elsif self.class.constants.include? lowercased
             token Keyword::Constant
-          elsif 'package'.casecmp m[0]
+          elsif lowercased == 'package'
             token Keyword::Namespace
           elsif m[1] == "@"
             token Name::Decorator