pygments.rb 1.1.1 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5021687249edac6151faaec1cec0187dea8eb311
-  data.tar.gz: f61e48727a7eb866ee5c5bd549ddce136095efc2
+SHA256:
+  metadata.gz: cb7e6901e07778261de7c0a6283696d5c1593ade93565caf32b2870e11477d39
+  data.tar.gz: 36d123e7aa363b8f50dfcd884e4d1f0721e6e75c83966c18d83f505e7bbf0b85
 SHA512:
-  metadata.gz: 05ec911f5a0aa423dd24da7ad7a4228989170790dee007347e401745c64d5c5fbc29b43cbe9e6a43f499f46ca5af8c504d0e0e29c2272aeb82fbcee524401b69
-  data.tar.gz: b93056fd8b559770b234958660c4643ac400cbedfcf65df9e20dfcf859651b75d3361b1723506ed6bf18d7ab30de128d15ca65ae2454974f73e345b8cc4bed9b
+  metadata.gz: 6ad9b6ac8dce86c289939ffbe3ee8c71268dd04ed3755798f08c75905cac90bf602236ae10448a44162809483ca5f88252985db7537d01818c5dcd348d60fe78
+  data.tar.gz: 728ca37e69f29ee9c74d2804e7583fdaf2284f330b9f3096612a88c2cc58833f49ad9a642eadd63e883a36cb7ea171b7f7892a205da709be67937e698a1d49f2

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+on:
+  push:
+    branches: [ '**' ]
+    tags-ignore: [ '**' ]
+  pull_request:
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [ 'jruby-9.2', '2.3', '3.0' ]
+        python: [ '3.5', '3.9' ]
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Run Tests
+        run: bundle exec rake test

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Publish to RubyGems.org
+on:
+  push:
+    tags: [ '*' ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+          bundler-cache: true
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+      - name: Build
+        run: bundle exec rake build
+      - name: Publish to RubyGems.org
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -1,6 +1,6 @@
-Gemfile.lock
-ext/Makefile
-lib/pygments_ext.*
-tmp
-pkg
+/.idea/
+/Gemfile.lock
+/pkg/
+/tmp
 *.pyc
+/lexers

data/CHANGELOG.adoc

@@ -0,0 +1,123 @@
+= {project-name} Changelog
+:project-name: pygments.rb
+:uri-repo: https://github.com/pygments/pygments.rb
+
+This document provides a high-level view of the changes to the {project-name} by release.
+For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
+
+== 2.0.0.rc3 (2021-01-08) - @slonopotamus
+
+* fix watchdog race condition leading to `ThreadError(<killed thread>)` on JRuby ({uri-repo}/pull/215[#215])
+
+== 2.0.0.rc2 (2021-01-07) - @slonopotamus
+
+* Fix release workflow
+
+== 2.0.0.rc1 (2021-01-07) - @slonopotamus
+
+* Modify `mentos.py` to run on Python 3.x instead of Python 2.7
+* Add `:timeout` parameter to allow for configurable timeouts
+* Add several Python 3.x versions to test matrix
+* Drop dependency on MultiJson
+* Fix hanging on JRuby + Windows
+* Update Pygments to 2.7.3
+* Drop GitHub custom lexers
+* Rework timeout handling
+* Improve error message when Python is not found
+* *Breaking change* Pygments.rb no longer sets default timeout for its operations
+* *Breaking change* Now pygments.rb raises `MentosError` instead of returning `nil` on timeout
+
+== 1.2.1 (2017-12-07)
+
+* Automatically update `lexers` cache on build ({uri-repo}/pull/186[#186])
++
+See {uri-repo}/pull/185[#185] for the reason
+
+== 1.2.0 (2017-09-13)
+
+* Exclude symlinks from the gem package to solve Windows issues ({uri-repo}/pull/181[#181])
+* Upgrade pygments to 2.0.0 ({uri-repo}/pull/180[#180])
+
+== 1.1.2 (2017-04-03)
+
+* Resolves {uri-repo}/pull/176[#176] exclude find_error.py symlink from gem ({uri-repo}/pull/177[#177])
+
+== 1.1.1 (2016-12-28)
+
+* Suppress Ruby 2.4.0's warnings ({uri-repo}/pull/172[#172])
+* Enable `frozen_string_literal` ({uri-repo}/pull/173[#173])
+
+== 1.1.0 (2016-12-24)
+
+* Support JRuby ({uri-repo}/pull/170[#170])
+* Make pygments.rb thread safe ({uri-repo}/pull/171[#171])
+
+== 1.0.0 (2016-12-11)
+
+* Upgrade bundled pygments to 2.2.0-HEAD ({uri-repo}/pull/167[#167])
++
+This includes *incompatible changes* because of upgrade of pygments.
+See https://pygments.org/ for details.
+* Relax yajl-ruby dependency to "~> 1.2" ({uri-repo}/pull/164[#164])
+* Python binary can be configured by `PYTMENTS_RB_PYTHON` env ({uri-repo}/pull/168[#168])
+* Improved error messages when python binary is missing ({uri-repo}/pull/158[#158])
+
+== 0.5.4 (2013-11-03)
+
+* Update lexers file
+
+== 0.5.3 (2013-09-17)
+
+* Fixes for Slash lexer
+* Improve highlighting for Slash lexer
+* Upgrade to latest pygments (1.7, changes summary follows.
+See pygments changelog for details)
+** Add Clay lexer
+** Add Perl 6 lexer
+** Add Swig lexer
+** Add nesC lexer
+** Add BlitzBasic lexer
+** Add EBNF lexer
+** Add Igor Pro lexer
+** Add Rexx lexer
+** Add Agda lexer
+** Recognize vim modelines
+** Improve Python 3 lexer
+** Improve Opa lexer
+** Improve Julia lexer
+** Improve Lasso lexer
+** Improve Objective C/C++ lexer
+** Improve Ruby lexer
+** Improve Stan lexer
+** Improve JavaScript lexer
+** Improve HTTP lexer
+** Improve Koka lexer
+** Improve Haxe lexer
+** Improve Prolog lexer
+** Improve F# lexer
+
+== 0.5.2 (2013-07-17)
+
+* Add Slash lexer
+
+== 0.5.1 (2013-06-25)
+
+* Ensure compatibility across distros by detecting if `python2` is available
+
+== 0.5.0 (2013-04-13)
+
+* Use `#rstrip` to fix table mode bug
+
+== 0.4.2 (2013-02-25)
+
+* Add new lexers, including custom lexers
+
+== 0.3.7 (2013-01-02)
+
+* Fixed missing custom lexers
+* Added syntax highlighting for Hxml
+
+== 0.3.4 (2012-12-28)
+
+* Add support for Windows
+* Add MIT license

data/Gemfile

@@ -1,2 +1,4 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 gemspec

data/LICENSE

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) Ted Nyman and Aman Gupta, 2012-2013
+Copyright (C) Ted Nyman, Aman Gupta, Marat Radchenko, 2012-2021
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
 associated documentation files (the "Software"), to deal in the Software without restriction, 

data/README.adoc

@@ -0,0 +1,161 @@
+= {project-name}
+Ted Nyman <ted@ted.io>; Aman Gupta <aman@tmm1.net>; Marat Radchenko <marat@slonopotamus.org>
+:project-name: pygments.rb
+:project-handle: pygments.rb
+:slug: pygments/{project-name}
+:toc: preamble
+:uri-project: https://github.com/{slug}
+:uri-ci: {uri-project}/actions?query=branch%3Amaster
+:uri-gem: https://rubygems.org/gems/{project-name}
+:uri-pygments: https://pygments.org/
+
+image:https://img.shields.io/gem/v/{project-name}.svg[Latest Release,link={uri-gem}]
+image:{uri-project}/workflows/CI/badge.svg?branch=master[Build Status,link={uri-ci}]
+
+== Introduction
+
+{project-name} is a Ruby wrapper for the Python {uri-pygments}[Pygments] syntax highlighter.
+
+{project-name} works by talking over a simple pipe to a long-lived Python child process.
+This library replaces https://github.com/github/albino[github/albino], as well as an older version of {project-name} that used an embedded Python interpreter.
+
+Each Ruby process that runs has its own 'personal Python'; for example, 4 Unicorn workers will have one Python process each.
+If a Python process dies, a new one will be spawned on the next pygments.rb request.
+
+== System Requirements
+
+- Python >= 3.5
+- Ruby >= 2.3
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'pygments.rb'
+----
+
+And then execute:
+
+[source,shell script]
+----
+$ bundle install
+----
+
+Or install pygments.rb gem yourself as:
+
+[source,shell script]
+----
+$ gem install pygments.rb
+----
+
+== Usage
+
+Require pygments.rb module:
+
+[source,ruby]
+----
+require 'pygments'
+----
+
+Highlight a file:
+
+[source,ruby]
+----
+Pygments.highlight(File.read(__FILE__), lexer: 'ruby')
+----
+
+Optionally, pass encoding and other lexer/formatter options via an `:options` hash:
+
+[source,ruby]
+----
+Pygments.highlight('code', options: {encoding: 'utf-8'})
+----
+
+pygments.rb uses HTML formatter by default.
+To use a different formatter, specify it via `:formatter` parameter:
+
+[source,ruby]
+----
+Pygments.highlight('code', formatter: 'bbcode')
+Pygments.highlight('code', formatter: 'terminal')
+----
+
+To generate CSS for HTML formatted code, use the `Pygments.css` method:
+
+[source,ruby]
+----
+Pygments.css
+Pygments.css('.highlight')
+----
+
+To use a specific pygments style, pass the `:style` option to the `Pygments.css` method:
+
+[source,ruby]
+----
+Pygments.css(style: 'monokai')
+----
+
+Other Pygments high-level API methods are also available.
+These methods return arrays detailing all the available lexers, formatters, and styles:
+
+[source,ruby]
+----
+Pygments.lexers
+Pygments.formatters
+Pygments.styles
+----
+
+To use a custom pygments installation, specify the path to
+`Pygments.start`:
+
+[source,ruby]
+----
+Pygments.start("/path/to/pygments")
+----
+
+If you'd like logging, set the environmental variable `MENTOS_LOG` to a file path for your logfile.
+
+You can apply a timeout to pygments.rb calls by specifying number of seconds in `MENTOS_TIMEOUT` environmental variable or by passing the `:timeout` argument (takes precedence over `MENTOS_TIMEOUT`):
+
+[source,ruby]
+----
+Pygments.highlight('code', timeout: 4)
+----
+
+== Benchmarks
+
+----
+$ ruby bench.rb 50
+   Benchmarking....
+   Size: 698 bytes
+   Iterations: 50
+                                                  user     system      total        real
+   pygments popen                                0.010000   0.010000   0.020000 (  0.460370)
+   pygments popen (process already started)      0.010000   0.000000   0.010000 (  0.272975)
+   pygments popen (process already started 2)    0.000000   0.000000   0.000000 (  0.273589)
+----
+
+----
+$ ruby bench.rb 10
+   Benchmarking....
+   Size: 15523 bytes
+   Iterations: 10
+                                                  user     system      total        real
+   pygments popen                               0.000000   0.000000   0.000000 (  0.819419)
+   pygments popen (process already started)     0.010000   0.000000   0.010000 (  0.676515)
+   pygments popen (process already started 2)   0.000000   0.010000   0.010000 (  0.674189)
+----
+
+== Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake test` to run the tests.
+
+== Copyright
+
+Copyright (C) Ted Nyman, Aman Gupta, Marat Radchenko, 2012-2021.
+Free use of this software is granted under the terms of the MIT License.
+
+For the full text of the license, see the link:LICENSE[] file.

data/Rakefile

@@ -1,7 +1,9 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-task :default => :test
+require 'bundler/gem_tasks'
+
+task default: :test
 
 # ==========================================================
 # Packaging
@@ -18,7 +20,6 @@ require 'rubygems/package_task'
 require 'rake/testtask'
 Rake::TestTask.new 'test' do |t|
   t.test_files = FileList['test/test_*.rb']
-  t.ruby_opts = ['-rubygems']
 end
 
 # ==========================================================
@@ -26,7 +27,7 @@ end
 # ==========================================================
 
 task :bench do
-  sh "ruby bench.rb"
+  sh 'ruby bench.rb'
 end
 
 # ==========================================================
@@ -35,33 +36,26 @@ end
 
 # Write all the lexers to a file for easy lookup
 task :lexers do
-  sh "ruby cache-lexers.rb"
+  sh 'ruby cache-lexers.rb'
 end
 
+task(:test).enhance([:lexers])
+task(:build).enhance([:lexers])
+
 # ==========================================================
 # Vendor
 # ==========================================================
 
 namespace :vendor do
   file 'vendor/pygments-main' do |f|
-    sh "hg clone https://bitbucket.org/birkenfeld/pygments-main #{f.name}"
-    sh "hg --repository #{f.name} identify --id > #{f.name}/REVISION"
-    rm_rf Dir["#{f.name}/.hg*"]
-    rm_rf Dir["#{f.name}/tests"]
+    sh "pip install --target=#{f.name} pygments"
+    sh "git add -- #{f.name}"
   end
 
   task :clobber do
     rm_rf 'vendor/pygments-main'
   end
 
-  # Load all the custom lexers in the `vendor/custom_lexers` folder
-  # and stick them in our custom Pygments vendor
-  task :load_lexers do
-    LEXERS_DIR = 'vendor/pygments-main/pygments/lexers'
-    lexers = FileList['vendor/custom_lexers/*.py']
-    lexers.each { |l| FileUtils.copy l, LEXERS_DIR }
-    FileUtils.cd(LEXERS_DIR) { sh "python _mapping.py" }
-  end
-
-  task :update => [:clobber, 'vendor/pygments-main', :load_lexers]
+  desc 'update vendor/pygments-main'
+  task update: [:clobber, 'vendor/pygments-main']
 end