commonmarker-rouge 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f2d7482d2e0c5a47e20eb907765080128f91ab3
-  data.tar.gz: 60f42f343d12babbb9e7c13d21ae5d207d969c1c
+SHA256:
+  metadata.gz: 38098d518c90e5a7622cc329a10b5bb44364b5cce34a2f8f445c6f2c7b4cace3
+  data.tar.gz: e982b682aa9d73f03a5679d75dfb50299befd6eb67bca03fd275866d5c54b49f
 SHA512:
-  metadata.gz: a9a4b020662d975972b57b6c21e3af6ae2675ab02b56ac4764feda4ed3c920fa6ad8bb45bb7ed15276693867220d4c5a163a948b1867de9e1813abd689557bdc
-  data.tar.gz: 8d3e11e5a0327f07348755afd339ae2afa2cfe5dd1144f6286746942cbe18e50604cb79e89c8a65aa55003488def04fe487145a334836f53398b7b64be062316
+  metadata.gz: 651e4d9cd9d435bef2349384fcd6500637f6887ac75daacece24ef0110b55a0cd2ff47491d1883b693fba66bdbba063a507724d85c16ca84d4d35256b780f947
+  data.tar.gz: d4914a022d511c1d8f46371f37aeaee5f98e45d538071420d15c04e8db84196b135764ee3243e30bcc92d0d22a34eedac49ddd630313317bf3c780c2f034a93f

data/.gitignore

@@ -10,6 +10,9 @@
 /test/version_tmp/
 /tmp/
 
+## IDE
+/.idea
+
 ## Specific to RubyMotion:
 .dat*
 .repl_history
@@ -20,12 +23,14 @@ build/
 /_yardoc/
 /doc/
 /rdoc/
+/docs/*.html
 
 ## Environment normalization:
 /.bundle/
 /vendor/bundle
 /lib/bundler/man/
 Gemfile.lock
+Gemfile.*.lock
 .ruby-version
 .ruby-gemset
 

data/.gitlab-ci.yml

@@ -0,0 +1,52 @@
+stages:
+  - test
+
+cache:
+  key: bundler-cache
+  paths:
+    - vendor/bundle
+
+.test:
+  before_script:
+    - bundle config path `pwd`/vendor/bundle
+    - bundle config without development_extra
+  script:
+    - bundle update
+    - bundle exec rspec
+    - bundle update --gemfile=Gemfile.lowest
+    - bundle exec rspec
+
+test-2.3:
+  extends: .test
+  stage: test
+  image: ruby:2.3
+
+test-2.4:
+  extends: .test
+  stage: test
+  image: ruby:2.4
+
+test-2.5:
+  extends: .test
+  stage: test
+  image: ruby:2.5
+
+test-2.6:
+  extends: .test
+  stage: test
+  image: ruby:2.6
+
+test-2.7:
+  extends: .test
+  stage: test
+  image: ruby:2.7
+
+test-3.0:
+  extends: .test
+  stage: test
+  image: ruby:3.0
+
+test-latest:
+  extends: .test
+  stage: test
+  image: ruby:latest

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+## 1.x
+
+### 1.5.1
+
+*Dec 9, 2023*
+
+* Allow Rouge 4
+
+### 1.5.0
+
+*Dec 1, 2018*
+
+* Added support for extensions and render options ([#3])
+* Fixed incompatibility with commonmarker 0.18
+* commonmarker 0.18 is now required
+
+### 1.4.0
+
+*Sep 26, 2017*
+
+* `:formatter` option now accepts formatter instance, for formatter class use `:formatter_class`. 
+    Class argument for `:formatter` is deprecated and will be removed in 2.0
+* fix `render_html` not properly accepting options
+
+### 1.3.0
+ 
+*Sep 26, 2017*
+
+* Allow Rouge 3.*
+
+### 1.2.0
+
+*Jun 9, 2017*
+
+* Add language-%fence_info% to highlighter-rouge div wrapper ([#2])
+* Allow using Rouge 2.x
+
+### 1.1.0
+
+*May 24, 2017*
+
+* Fixed incompatibility with commonmarker >= 0.14.5 ([#1])
+* commonmarker >= 0.14.5 is now required
+
+### 1.0.1
+
+*Nov 17, 2016*
+
+* Relax commonmarker requirement
+
+### 1.0.0
+
+*Apr 5, 2016*
+
+* Initial release
+
+[#1]: https://github.com/sandfoxme/commonmarker-rouge/pull/1
+[#2]: https://github.com/sandfoxme/commonmarker-rouge/pull/2
+[#3]: https://github.com/sandfoxme/commonmarker-rouge/pull/3

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
+# for low ruby versions
+gem 'ruby-enum', '~> 0.7.0'
+
+group :development_extra do
+  gem 'simplecov'
+  gem 'pry'
+end
+
 gemspec

data/Gemfile.lowest

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# for low ruby versions
+gem 'ruby-enum', '~> 0.7.0'
+
+gemspec
+
+# lowest dependencies to test
+
+gem 'commonmarker', '0.18.0'
+gem 'rouge', '1.10'

data/README.md

@@ -1,14 +1,16 @@
 # CommonMarker+Rouge
 
-[![Gem](https://img.shields.io/gem/v/commonmarker-rouge.svg?maxAge=2592000)](https://rubygems.org/gems/commonmarker-rouge)
-[![Travis](https://img.shields.io/travis/sandfoxme/commonmarker-rouge.svg?maxAge=2592000)](https://travis-ci.org/sandfoxme/commonmarker-rouge)
-[![Code Climate](https://img.shields.io/codeclimate/github/sandfoxme/commonmarker-rouge.svg?maxAge=2592000)](https://codeclimate.com/github/sandfoxme/commonmarker-rouge)
-[![Code Climate](https://img.shields.io/codeclimate/coverage/github/sandfoxme/commonmarker-rouge.svg?maxAge=2592000)](https://codeclimate.com/github/sandfoxme/commonmarker-rouge/coverage)
-[![Gemnasium](https://img.shields.io/gemnasium/sandfoxme/commonmarker-rouge.svg?maxAge=2592000)](https://gemnasium.com/sandfoxme/commonmarker-rouge)
+[![Gem](https://img.shields.io/gem/v/commonmarker-rouge.svg?style=flat-square)](https://rubygems.org/gems/commonmarker-rouge)
+[![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline/sandfox/commonmarker-rouge/master.svg?style=flat-square)](https://gitlab.com/sandfox/commonmarker-rouge/-/pipelines)
 
 A [CommonMarker](https://rubygems.org/gems/commonmarker) wrapper with
 syntax highlight support by [Rouge](https://rubygems.org/gems/rouge).
 
+## IMPORTANT
+
+`commonmarker-rouge` currently works only with renderer in `:UNSAFE` mode.
+Don't forget to set `:UNSAFE` manually if you're overwriting the renderer mode.
+
 ## Installation
 
 Add these lines to your application's Gemfile:
@@ -17,38 +19,14 @@ Add these lines to your application's Gemfile:
 gem 'commonmarker-rouge'
 ```
 
-## Usage
-
-```ruby
-# use default CommonMarker class and Rouge::Formatters::HTML formatter
-CommonMarker::Rouge.render_html(content)
-
-# get CommonMarker parsed AST
-CommonMarker::Rouge.render_doc(content)
+## Documentation
 
-# pass options to CommonMarker
-CommonMarker::Rouge.render_html(content, [:SAFE, :SOURCEPOS])
+Read full documentation here: <https://sandfox.dev/ruby/commonmarker-rouge.html>
 
-# use custom CommonMarker wrapper (must provide compatible render_doc)
-CommonMarker::Rouge.render_html(content, cmark_class: CommonMarkerWrapper)
+## Support
 
-# use custom Rouge formatter by class
-CommonMarker::Rouge.render_html(content, formatter_class: Rouge::Formatters::HTMLLinewise)
-# or by instance
-CommonMarker::Rouge.render_html(content, formatter: Rouge::Formatters::HTMLTable.new(
-  Rouge::Formatters::HTML.new
-))
-
-# pass some options to Rouge
-CommonMarker::Rouge.render_html(content, options: { css_class: 'custom-class' })
-# or
-CommonMarker::Rouge.render_html(content, formatter: Rouge::Formatters::HTMLTable.new(
-  Rouge::Formatters::HTML.new, code_class: 'rouge-code'
-))
-
-```
+Please file issues on our main repo at GitLab: <https://gitlab.com/sandfox/commonmarker-rouge/-/issues>
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/console

@@ -4,4 +4,5 @@ require 'bundler/setup'
 require 'commonmarker/rouge'
 
 require 'pry'
+
 Pry.start

data/commonmarker-rouge.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = 'commonmarker-rouge'
   spec.version       = CommonMarker::Rouge::VERSION
   spec.authors       = ['Anton Smirnov']
-  spec.email         = ['sandfox@sandfox.me']
+  spec.email         = ['sandfox+gem@sandfox.me']
 
   spec.summary       = 'CommonMarker wrapper with Rouge syntax highlighter'
-  spec.homepage      = 'https://github.com/sandfoxme/commonmarker-rouge'
+  spec.homepage      = 'https://sandfox.dev/ruby/commonmarker-rouge.html'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,13 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'commonmarker', '>= 0.14.5', '< 1.0'
-  spec.add_dependency 'rouge',        '>= 1.10', '< 4'
+  spec.add_dependency 'commonmarker', '>= 0.18.0', '< 1.0'
+  spec.add_dependency 'rouge',        '>= 1.10', '< 5'
 
-  spec.add_development_dependency 'bundler',  '~> 1.11'
-  spec.add_development_dependency 'rake',     '~> 12.0'
+  spec.add_development_dependency 'bundler',  '>= 1.11'
+  spec.add_development_dependency 'rake',     '>= 12.0', '< 14'
   spec.add_development_dependency 'rspec',    '~> 3.0'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'pry'
 end

data/docs/index.rst

@@ -0,0 +1,88 @@
+CommonMarker+Rouge
+##################
+
+|RubyGems| |GitLab| |GitHub| |Bitbucket| |Gitea|
+
+A CommonMarker_ wrapper with syntax highlight support by Rouge_.
+
+.. important::
+    ``commonmarker-rouge`` currently works only with renderer in ``:UNSAFE`` mode.
+    Don't forget to set ``:UNSAFE`` manually if you're overwriting the renderer mode.
+
+Installation
+============
+
+Add these lines to your application's Gemfile:
+
+.. code-block:: ruby
+
+    gem 'commonmarker-rouge'
+
+Usage
+=====
+
+Review the CommonMarker options to understand how to use the ``render_html`` command:
+
+* 1st parameter (optional) - `parse options`_
+* 2nd parameter (optional) - `render options`_
+* 3rd parameter (optional) - `extensions`_
+
+.. code-block:: ruby
+
+    # use default CommonMarker class and Rouge::Formatters::HTML formatter
+    CommonMarker::Rouge.render_html(content)
+
+    # Basic examples with 1st and 2nd optional parameters
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:UNSAFE])
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:SOURCEPOS])
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:UNSAFE, :SOURCEPOS])
+
+    # use GitHub extensions - both 1st/2nd parameters required
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:DEFAULT], [:table])
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:DEFAULT], [:table, :strikethrough])
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:DEFAULT], [:table, :strikethrough, :autolink])
+    CommonMarker::Rouge.render_html(content, [:DEFAULT], [:DEFAULT], [:table, :strikethrough, :tagfilter])
+
+    # get CommonMarker parsed AST
+    CommonMarker::Rouge.render_doc(content)
+
+    # use custom CommonMarker wrapper (must provide compatible render_doc)
+    CommonMarker::Rouge.render_html(content, cmark_class: CommonMarkerWrapper)
+
+    # use custom Rouge formatter by class
+    CommonMarker::Rouge.render_html(content, formatter_class: Rouge::Formatters::HTMLLinewise)
+    # or by instance
+    CommonMarker::Rouge.render_html(content, formatter: Rouge::Formatters::HTMLTable.new(
+      Rouge::Formatters::HTML.new
+    ))
+
+    # pass some options to Rouge
+    CommonMarker::Rouge.render_html(content, options: { css_class: 'custom-class' })
+    # or
+    CommonMarker::Rouge.render_html(content, formatter: Rouge::Formatters::HTMLTable.new(
+      Rouge::Formatters::HTML.new, code_class: 'rouge-code'
+    ))
+
+License
+=======
+
+The gem is available as open source under the terms of the `MIT License`_.
+
+.. _CommonMarker:   https://rubygems.org/gems/commonmarker
+.. _Rouge:          https://rubygems.org/gems/rouge
+.. _MIT License:    http://opensource.org/licenses/MIT
+
+.. _parse options:  https://github.com/gjtorikian/commonmarker#parse-options
+.. _render options: https://github.com/gjtorikian/commonmarker#render-options
+.. _extensions:     https://github.com/gjtorikian/commonmarker#extensions
+
+.. |RubyGems|   image:: https://img.shields.io/gem/v/commonmarker-rouge.svg?style=flat-square
+   :target:     https://rubygems.org/gems/commonmarker-rouge
+.. |GitHub|     image:: https://img.shields.io/badge/get%20on-GitHub-informational.svg?style=flat-square&logo=github
+   :target:     https://github.com/arokettu/commonmarker-rouge
+.. |GitLab|     image:: https://img.shields.io/badge/get%20on-GitLab-informational.svg?style=flat-square&logo=gitlab
+   :target:     https://gitlab.com/sandfox/commonmarker-rouge
+.. |Bitbucket|  image:: https://img.shields.io/badge/get%20on-Bitbucket-informational.svg?style=flat-square&logo=bitbucket
+   :target:     https://bitbucket.org/sandfox/commonmarker-rouge
+.. |Gitea|      image:: https://img.shields.io/badge/get%20on-Gitea-informational.svg?style=flat-square&logo=gitea
+   :target:     https://sandfox.org/sandfox/commonmarker-rouge

data/lib/commonmarker/rouge/version.rb

@@ -1,5 +1,5 @@
 module CommonMarker
   module Rouge
-    VERSION = '1.4.0'
+    VERSION = '1.5.1'
   end
 end

data/lib/commonmarker/rouge.rb

@@ -8,16 +8,17 @@ module CommonMarker
   module Rouge
     module_function
 
-    def render_doc(text, cmark_options = :DEFAULT, **cmr_options)
+    def render_doc(text, cmark_options = :DEFAULT, extensions = [], **cmr_options)
       cmark = cmr_options[:cmark_class] || ::CommonMarker
 
-      ast = cmark.render_doc(text, cmark_options)
+      ast = cmark.render_doc(text, cmark_options, extensions)
       process_ast(ast, cmr_options)
       ast
     end
 
-    def render_html(text, cmark_options = :DEFAULT, **cmr_options)
-      render_doc(text, cmark_options, **cmr_options).to_html
+    def render_html(text, cmark_options = :DEFAULT, render_options = :UNSAFE, extensions = [], **cmr_options)
+      doc = render_doc(text, cmark_options, extensions, **cmr_options)
+      doc.to_html(render_options)
     end
 
     def process_ast(ast, cmr_options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker-rouge
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Anton Smirnov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2023-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.5
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.5
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -39,7 +39,7 @@ dependencies:
         version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,35 +49,41 @@ dependencies:
         version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,72 +98,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
-- sandfox@sandfox.me
+- sandfox+gem@sandfox.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lowest
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - commonmarker-rouge.gemspec
+- docs/index.rst
 - lib/commonmarker/rouge.rb
 - lib/commonmarker/rouge/version.rb
-homepage: https://github.com/sandfoxme/commonmarker-rouge
+homepage: https://sandfox.dev/ruby/commonmarker-rouge.html
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: CommonMarker wrapper with Rouge syntax highlighter
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-dist: trusty
-rvm:
-  - '2.0.0'
-  - '2.1.10'
-  - '2.2.6'
-  - '2.3.3'
-  - '2.4.0'
-  - ruby-head
-before_install: gem install bundler
-script: bundle exec rspec && if [ -d coverage ]; then bundle exec codeclimate-test-reporter; fi