rouge 3.0.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 105d563933ea57ff19cca03ab1fd98fc3b01ea3a
-  data.tar.gz: 72e6098b1419ff753ddb8bf748d6822d5fc5c1a5
+SHA256:
+  metadata.gz: 579264110ed9ae2f82195af1d9d83d2ebf6288f8ce3cd6909c2a9d563ae0e1d5
+  data.tar.gz: 25a1809f05ec5aab6f04ee7b885a17cf8b1388e1247284e773bc166d13a9e296
 SHA512:
-  metadata.gz: 6346ab18ab19b7758e3f37eec75ddeac72a11edacd4416783dbfaccb33e3aadda9841373db11436a9fe4fbdd457a8bb2f4575f79b2c546e596b9d9cc829612e3
-  data.tar.gz: 9df1ed34e20dfbb2733ebef31d80792547913afdff931c556e73ff731875968233f12e1c62e91cfbaa84d4653b684aeec5e9a4778ff16fb3c5279585b974a846
+  metadata.gz: 832c13a7236b814d53a5a6b170fc00b4961efb2cdee91053bfc3a6386a9bc6c7b071f9fa51606321e94249b57c6f549f6e4bb420e7647ab68ca6a3c6e49d8c63
+  data.tar.gz: 5889f29c2788788120fd698ec004b847c5bafb7df0b22af36c9f1d2a78218c81e7fd136b359b586ed8f586e0a65eceb156721efcb95d95e3af7df34d0b174038

data/Gemfile

@@ -1,26 +1,40 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem 'bundler', '~> 1.15'
 gem 'rake'
 
 gem 'minitest', '>= 5.0'
 gem 'minitest-power_assert'
 
+gem 'parallel', '~> 1.13.0' if RUBY_VERSION < '2.2.0'
 gem 'rubocop', '~> 0.49.1'
 
 # don't try to install redcarpet under jruby
 gem 'redcarpet', :platforms => :ruby
 
+# Profiling
+if RUBY_VERSION >= '2.3.0'
+  gem 'memory_profiler', :require => false
+end
+
+# Needed for a Rake task
+gem 'git'
+gem 'yard'
+
 group :development do
   gem 'pry'
 
   # docs
-  gem 'yard'
   gem 'github-markup'
 
   # for visual tests
-  gem 'sinatra'
+  if RUBY_VERSION < '2.2.0'
+    gem 'sinatra', '~> 1.4.8'
+  else
+    gem 'sinatra'
+  end
   gem 'shotgun'
 end

data/bin/rougify

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'pathname'
 ROOT_DIR = Pathname.new(__FILE__).dirname.parent

data/lib/rouge.rb

@@ -1,10 +1,15 @@
 # -*- coding: utf-8 -*- #
+# frozen_string_literal: true
 
 # stdlib
 require 'pathname'
 
 # The containing module for Rouge
 module Rouge
+  # cache value in a constant since `__dir__` allocates a new string
+  # on every call.
+  LIB_DIR = __dir__.freeze
+
   class << self
     def reload!
       Object.send :remove_const, :Rouge
@@ -30,53 +35,73 @@ module Rouge
 
       formatter.format(lexer.lex(text), &b)
     end
-  end
-end
 
-load_dir = Pathname.new(__FILE__).dirname
-load load_dir.join('rouge/version.rb')
+    # Load a file relative to the `lib/rouge` path.
+    #
+    # @api private
+    def load_file(path)
+      load File.join(LIB_DIR, "rouge/#{path}.rb")
+    end
 
-load load_dir.join('rouge/util.rb')
+    # Load the lexers in the `lib/rouge/lexers` directory.
+    #
+    # @api private
+    def load_lexers
+      # The trailing slash is necessary to avoid lexers being loaded multiple
+      # times by `Lexers.load_lexer`
+      lexer_dir = File.join(LIB_DIR, "rouge/lexers/")
+      Dir.glob(File.join(lexer_dir, '*.rb')).each do |f|
+        Lexers.load_lexer(f.sub(lexer_dir, ''))
+      end
+    end
+  end
+end
 
-load load_dir.join('rouge/text_analyzer.rb')
-load load_dir.join('rouge/token.rb')
+Rouge.load_file 'version'
+Rouge.load_file 'util'
+Rouge.load_file 'text_analyzer'
+Rouge.load_file 'token'
 
-load load_dir.join('rouge/lexer.rb')
-load load_dir.join('rouge/regex_lexer.rb')
-load load_dir.join('rouge/template_lexer.rb')
+Rouge.load_file 'lexer'
+Rouge.load_file 'regex_lexer'
+Rouge.load_file 'template_lexer'
 
-lexers_dir = load_dir.join('rouge/lexers')
-Dir.glob(lexers_dir.join('*.rb')).each do |f|
-  Rouge::Lexers.load_lexer(Pathname.new(f).relative_path_from(lexers_dir).to_s)
-end
+Rouge.load_lexers
 
-load load_dir.join('rouge/guesser.rb')
-load load_dir.join('rouge/guessers/util.rb')
-load load_dir.join('rouge/guessers/glob_mapping.rb')
-load load_dir.join('rouge/guessers/modeline.rb')
-load load_dir.join('rouge/guessers/filename.rb')
-load load_dir.join('rouge/guessers/mimetype.rb')
-load load_dir.join('rouge/guessers/source.rb')
-load load_dir.join('rouge/guessers/disambiguation.rb')
+Rouge.load_file 'guesser'
+Rouge.load_file 'guessers/util'
+Rouge.load_file 'guessers/glob_mapping'
+Rouge.load_file 'guessers/modeline'
+Rouge.load_file 'guessers/filename'
+Rouge.load_file 'guessers/mimetype'
+Rouge.load_file 'guessers/source'
+Rouge.load_file 'guessers/disambiguation'
 
-load load_dir.join('rouge/formatter.rb')
-load load_dir.join('rouge/formatters/html.rb')
-load load_dir.join('rouge/formatters/html_table.rb')
-load load_dir.join('rouge/formatters/html_pygments.rb')
-load load_dir.join('rouge/formatters/html_legacy.rb')
-load load_dir.join('rouge/formatters/html_linewise.rb')
-load load_dir.join('rouge/formatters/html_inline.rb')
-load load_dir.join('rouge/formatters/terminal256.rb')
-load load_dir.join('rouge/formatters/null.rb')
+Rouge.load_file 'formatter'
+Rouge.load_file 'formatters/html'
+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_table'
+Rouge.load_file 'formatters/html_inline'
+Rouge.load_file 'formatters/terminal256'
+Rouge.load_file 'formatters/terminal_truecolor'
+Rouge.load_file 'formatters/tex'
+Rouge.load_file 'formatters/null'
 
-load load_dir.join('rouge/theme.rb')
-load load_dir.join('rouge/themes/thankful_eyes.rb')
-load load_dir.join('rouge/themes/colorful.rb')
-load load_dir.join('rouge/themes/base16.rb')
-load load_dir.join('rouge/themes/github.rb')
-load load_dir.join('rouge/themes/igor_pro.rb')
-load load_dir.join('rouge/themes/monokai.rb')
-load load_dir.join('rouge/themes/molokai.rb')
-load load_dir.join('rouge/themes/monokai_sublime.rb')
-load load_dir.join('rouge/themes/gruvbox.rb')
-load load_dir.join('rouge/themes/tulip.rb')
+Rouge.load_file 'theme'
+Rouge.load_file 'tex_theme_renderer'
+Rouge.load_file 'themes/thankful_eyes'
+Rouge.load_file 'themes/colorful'
+Rouge.load_file 'themes/base16'
+Rouge.load_file 'themes/github'
+Rouge.load_file 'themes/igor_pro'
+Rouge.load_file 'themes/monokai'
+Rouge.load_file 'themes/molokai'
+Rouge.load_file 'themes/monokai_sublime'
+Rouge.load_file 'themes/gruvbox'
+Rouge.load_file 'themes/tulip'
+Rouge.load_file 'themes/pastie'
+Rouge.load_file 'themes/bw'
+Rouge.load_file 'themes/magritte'

data/lib/rouge/cli.rb

@@ -1,8 +1,11 @@
 # -*- coding: utf-8 -*- #
+# frozen_string_literal: true
 
 # not required by the main lib.
 # to use this module, require 'rouge/cli'.
 
+require 'rbconfig'
+
 module Rouge
   class FileReader
     attr_reader :input
@@ -37,7 +40,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}|
@@ -47,6 +50,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
 
@@ -61,18 +67,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={})
@@ -90,7 +100,7 @@ module Rouge
       case arg
       when 'version', '--version', '-v'
         Version
-      when 'help'
+      when 'help', nil
         Help
       when 'highlight', 'hi'
         Highlight
@@ -185,11 +195,29 @@ module Rouge
         yield %[]
         yield %[--require|-r <filename>     require a filename or library before]
         yield %[                            highlighting]
+        yield %[]
+        yield %[--escape                    allow the use of escapes between <! and !>]
+        yield %[]
+        yield %[--escape-with <l> <r>       allow the use of escapes between custom]
+        yield %[                            delimiters. implies --escape]
+      end
+
+      # There is no consistent way to do this, but this is used elsewhere,
+      # and we provide explicit opt-in and opt-out with $COLORTERM
+      def self.supports_truecolor?
+        return true if %w(24bit truecolor).include?(ENV['COLORTERM'])
+        return false if ENV['COLORTERM'] && ENV['COLORTERM'] =~ /256/
+
+        if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+          ENV['ConEmuANSI'] == 'ON' && !ENV['ANSICON']
+        else
+          ENV['TERM'] !~ /(^rxvt)|(-color$)/
+        end
       end
 
       def self.parse(argv)
         opts = {
-          :formatter => 'terminal256',
+          :formatter => supports_truecolor? ? 'terminal-truecolor' : 'terminal256',
           :theme => 'thankful_eyes',
           :css_class => 'codehilite',
           :input_file => '-',
@@ -217,6 +245,10 @@ module Rouge
             opts[:css_class] = argv.shift
           when '--lexer-opts', '-L'
             opts[:lexer_opts] = parse_cgi(argv.shift)
+          when '--escape'
+            opts[:escape] = ['<!', '!>']
+          when '--escape-with'
+            opts[:escape] = [argv.shift, argv.shift]
           when /^--/
             error! "unknown option #{arg.inspect}"
           else
@@ -243,11 +275,23 @@ module Rouge
         )
       end
 
+      def raw_lexer
+        lexer_class.new(@lexer_opts)
+      end
+
+      def escape_lexer
+        Rouge::Lexers::Escape.new(
+          start: @escape[0],
+          end: @escape[1],
+          lang: raw_lexer,
+        )
+      end
+
       def lexer
-        @lexer ||= lexer_class.new(@lexer_opts)
+        @lexer ||= @escape ? escape_lexer : raw_lexer
       end
 
-      attr_reader :input_file, :lexer_name, :mimetype, :formatter
+      attr_reader :input_file, :lexer_name, :mimetype, :formatter, :escape
 
       def initialize(opts={})
         Rouge::Lexer.enable_debug!
@@ -270,19 +314,26 @@ module Rouge
 
         theme = Theme.find(opts[:theme]).new or error! "unknown theme #{opts[:theme]}"
 
+        # TODO: document this in --help
         @formatter = case opts[:formatter]
         when 'terminal256' then Formatters::Terminal256.new(theme)
+        when 'terminal-truecolor' then Formatters::TerminalTruecolor.new(theme)
         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
+
+        @escape = opts[:escape]
       end
 
       def run
+        Formatter.enable_escape! if @escape
         formatter.format(lexer.lex(input), &method(:print))
       end
 
@@ -304,21 +355,35 @@ module Rouge
         yield %|usage: rougify style [<theme-name>] [<options>]|
         yield %||
         yield %|Print CSS styles for the given theme.  Extra options are|
-        yield %|passed to the theme.  Theme defaults to thankful_eyes.|
+        yield %|passed to the theme. To select a mode (light/dark) for the|
+        yield %|theme, append '.light' or '.dark' to the <theme-name>|
+        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
@@ -335,6 +400,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
@@ -363,7 +432,7 @@ module Rouge
         puts "== Available Lexers =="
 
         Lexer.all.sort_by(&:tag).each do |lexer|
-          desc = "#{lexer.desc}"
+          desc = String.new("#{lexer.desc}")
           if lexer.aliases.any?
             desc << " [aliases: #{lexer.aliases.join(',')}]"
           end

data/lib/rouge/demos/ada

@@ -0,0 +1,26 @@
+with Ada.Directories;
+with Ada.Direct_IO;
+with Ada.Text_IO;
+
+procedure Extra_IO.Read_File (Name : String) is
+
+   package Dirs renames Ada.Directories;
+   package Text_IO renames Ada.Text_IO;
+
+   -- Get the size of the file for a new string.
+   Size : Natural := Natural (Dirs.Size (Name));
+   subtype File_String is String (1 .. Size);
+
+   -- Instantiate Direct_IO for our file type.
+   package FIO is new Ada.Direct_IO (File_String);
+
+   File     : FIO.File_Type;
+   Contents : File_String;
+
+begin
+   FIO.Open (File, FIO.In_File, Name);
+   FIO.Read (File, Contents);
+   FIO.Close (File);
+
+   Text_IO.Put (Contents);
+end Extra_IO.Read_File;

data/lib/rouge/demos/apex

@@ -0,0 +1,9 @@
+public class with sharing Trigger {
+    @Deprecated
+    public void resolveSum(int x, int y) {
+        System.debug('x is ' + x);
+        System.debug('y is ' + y);
+
+        System.debug('x + y = ' + (x+y));
+    }
+}