jekyll-commonmark 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 647af3a419ecde37fd6a43f237daac517b22aa12
-  data.tar.gz: b85ba6624adf206e2a6d066b212651d13e413106
+SHA256:
+  metadata.gz: 1bda6fd984f53c9027917fa0e75046c6962532478d039de9155ac344923d8021
+  data.tar.gz: 675a90e1ef61e9c43481208adb3acba8f949383198a4c28d00f7573d59caf9fb
 SHA512:
-  metadata.gz: 7375fa11944b9dbdac92031ae3393410186b90935fbbdc8a26ca046d6b6c3547c735536bd347c05fe39a6303f3b29b95140839b62fc0405e0aae946f247661db
-  data.tar.gz: 64a551c101c3d84045db1f6c6d193d54729ea87f91792f448aad9d34e40aa13bd0c91cb51cb8c77368901886403115dc8795dc5a5c058270dfec3003d8d5bd41
+  metadata.gz: 0c4d619ba9bea75f6e74e025ecf1b30f5399412cad0567e3f7c1f92e1507b91c325821e51fb40c5986255871992ab31c417ef791b669dd66551992fe2b372d4e
+  data.tar.gz: c13e47638595170762778b8b297dc41a90739161797203300f1f4454720a8743eda74f30cc1665ea5c60e732d2f3f947603f21d796cadb0c9853134e46613bed

data/History.markdown

@@ -0,0 +1,55 @@
+## 1.4.0 / 2022-01-30
+
+### Minor Enhancements
+
+  * Require at least commonmarker-0.22 (#44)
+  * Highlight fenced code-block contents with Rouge (#29)
+
+### Bug Fixes
+
+  * Refactor away extra abstractions (#53)
+
+### Development Fixes
+
+  * DRY begin-rescue-end block with a private helper (#28)
+  * Fix failing CI builds (#33)
+  * Remove gemspec dependency on Jekyll (#34)
+  * Test rendering with invalid configuration (#27)
+  * Refactor to improve readability (#37)
+  * Set up Continuous Integration via GH Actions (#46)
+  * Clean up gemspec (#47)
+  * Add workflow to release gem via GH Actions (#54)
+
+### Documentation
+
+  * Update README to link to commonmarker (#38)
+
+## 1.3.1 / 2019-03-25
+
+### Bug Fixes
+
+  * Re-introduce Ruby 2.3 support and test Jekyll 3.7+ (#32)
+
+## 1.3.0 / 2019-03-22
+
+### Development Fixes
+
+  * Allow Jekyll v4 (still alpha)
+  * Drop Ruby < 2.4
+  * chore(deps): rubocop-jekyll 0.3.0 (#25)
+  * Target Ruby 2.4 (#30)
+
+## 1.2.0 / 2018-03-29
+
+### Minor Enhancements
+
+  * Allow render options (#4)
+  * Only set options once (#17)
+
+### Development Fixes
+
+  * Test plugin on Windows (#13)
+  * Allow options passed to Rubocop (#15)
+  * Add tests (#16)
+  * Test against Ruby 2.5 (#18)
+  * Version with class (#19)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Pat Hawks
+Copyright (c) 2015-present Pat Hawks and jekyll-commonmark contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Readme.md

@@ -3,10 +3,13 @@
 *CommonMark Markdown converter for Jekyll*
 
 [![Gem Version](https://img.shields.io/gem/v/jekyll-commonmark.svg)](https://rubygems.org/gems/jekyll-commonmark)
-[![Build Status](https://img.shields.io/travis/pathawks/jekyll-commonmark/master.svg)](https://travis-ci.org/pathawks/jekyll-commonmark)
-[![Dependency Status](https://img.shields.io/gemnasium/pathawks/jekyll-commonmark.svg)](https://gemnasium.com/pathawks/jekyll-commonmark)
+[![Build Status](https://img.shields.io/travis/jekyll/jekyll-commonmark/master.svg)](https://travis-ci.org/jekyll/jekyll-commonmark)
+[![Windows Build status](https://img.shields.io/appveyor/ci/pathawks/jekyll-commonmark/master.svg?label=Windows%20build)](https://ci.appveyor.com/project/pathawks/jekyll-commonmark)
 
-Jekyll Markdown converter that uses [libcmark](https://github.com/jgm/CommonMark), the reference parser for CommonMark.
+Jekyll Markdown converter that uses [libcmark-gfm](https://github.com/github/cmark-gfm) (via [commonmarker](https://github.com/gjtorikian/commonmarker)). 
+As a result, it is faster than Kramdown.
+
+GitHub Pages supports CommonMark through https://github.com/github/jekyll-commonmark-ghpages
 
 ## Installation
 
@@ -23,3 +26,13 @@ and modify your `_config.yml` to use **CommonMark** as your Markdown converter
 ```yaml
 markdown: CommonMark
 ```
+
+## Configuration
+
+To specify [extensions](https://github.com/gjtorikian/commonmarker#extensions) and [options](https://github.com/gjtorikian/commonmarker#options) for use in converting Markdown to HTML, supply options to the Markdown converter:
+
+```yaml
+commonmark:
+  options: ["SMART", "FOOTNOTES"]
+  extensions: ["strikethrough", "autolink", "table"]
+```

data/lib/jekyll-commonmark/html_renderer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Converters
+    class Markdown
+      class CommonMark
+        class HtmlRenderer < CommonMarker::HtmlRenderer
+          def code_block(node)
+            block do
+              lang = extract_code_lang(node.fence_info)
+
+              out('<div class="')
+              out("language-", lang, " ") if lang
+              out('highlighter-rouge"><div class="highlight">')
+              out("<pre", sourcepos(node), ' class="highlight"')
+
+              if option_enabled?(:GITHUB_PRE_LANG)
+                out_data_attr(lang)
+                out("><code>")
+              else
+                out("><code")
+                out_data_attr(lang)
+                out(">")
+              end
+              out(render_with_rouge(node.string_content, lang))
+              out("</code></pre></div></div>")
+            end
+          end
+
+          private
+
+          def extract_code_lang(info)
+            return unless info.is_a?(String)
+            return if info.empty?
+
+            info.split(%r!\s+!)[0]
+          end
+
+          def out_data_attr(lang)
+            return unless lang
+
+            out(' data-lang="', lang, '"')
+          end
+
+          def render_with_rouge(code, lang)
+            require "rouge"
+
+            formatter = Rouge::Formatters::HTMLLegacy.new(
+              :line_numbers => false,
+              :wrap         => false,
+              :css_class    => "highlight",
+              :gutter_class => "gutter",
+              :code_class   => "code"
+            )
+            lexer = Rouge::Lexer.find_fancy(lang, code) || Rouge::Lexers::PlainText
+            formatter.format(lexer.lex(code))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-commonmark/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module CommonMark
+    VERSION = "1.4.0"
+  end
+end

data/lib/jekyll-commonmark.rb

@@ -1,41 +1,65 @@
-# Frozen-string-literal: true
-# Encoding: utf-8
+# frozen-string-literal: true
 
 module Jekyll
   module Converters
-    class Markdown::CommonMark
-      def initialize(config)
-        Jekyll::External.require_with_graceful_fail "commonmarker"
-        begin
-          @options = config['commonmark']['options'].collect { |e| e.upcase.to_sym }
-        rescue NoMethodError
-          @options = [:DEFAULT]
-        else
-          @options.reject! do |e|
-            unless CommonMarker::Config::Parse.keys.include? e
-              Jekyll.logger.warn "CommonMark:", "#{e} is not a valid option"
-              Jekyll.logger.info "Valid options:", CommonMarker::Config::Parse.keys.join(", ")
-              true
-            end
+    class Markdown
+      class CommonMark
+        autoload :HtmlRenderer, "jekyll-commonmark/html_renderer"
+
+        def initialize(config)
+          Jekyll::External.require_with_graceful_fail "commonmarker"
+
+          parse_keys  = CommonMarker::Config::OPTS[:parse].keys
+          render_keys = CommonMarker::Config::OPTS[:render].keys
+
+          options = setup_options(config, parse_keys, render_keys)
+          options_set = Set.new(options)
+
+          @extensions = setup_extensions(config)
+
+          @parse_options  = (options_set & parse_keys).to_a
+          @render_options = (options_set & render_keys).to_a
+
+          @parse_options  = :DEFAULT if @parse_options.empty?
+          @render_options = :DEFAULT if @render_options.empty?
+        end
+
+        def convert(content)
+          HtmlRenderer.new(
+            :options    => @render_options,
+            :extensions => @extensions
+          ).render(
+            CommonMarker.render_doc(content, @parse_options, @extensions)
+          )
+        end
+
+        private
+
+        def validate(list, bucket, type)
+          list.reject do |item|
+            next if bucket.include?(item)
+
+            Jekyll.logger.warn "CommonMark:", "#{item} is not a valid #{type}"
+            Jekyll.logger.info "Valid #{type}s:", bucket.join(", ")
+            true
           end
         end
-        begin
-          @extensions = config['commonmark']['extensions'].collect { |e| e.to_sym }
+
+        def setup_options(config, parse_keys, render_keys)
+          options    = config["commonmark"]["options"].collect { |e| e.upcase.to_sym }
+          valid_opts = Set.new(parse_keys + render_keys).to_a
+          validate(options, valid_opts, "option")
         rescue NoMethodError
-          @extensions = []
-        else
-          @extensions.reject! do |e|
-            unless CommonMarker.extensions.include? e.to_s
-              Jekyll.logger.warn "CommonMark:", "#{e} is not a valid extension"
-              Jekyll.logger.info "Valid extensions:", CommonMarker.extensions.join(", ")
-              true
-            end
-          end
+          []
         end
-      end
 
-      def convert(content)
-        CommonMarker.render_doc(content, @options, @extensions).to_html
+        def setup_extensions(config)
+          extensions       = config["commonmark"]["extensions"].collect(&:to_sym)
+          valid_extensions = CommonMarker.extensions.collect(&:to_sym)
+          validate(extensions, valid_extensions, "extension")
+        rescue NoMethodError
+          []
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-commonmark
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Pat Hawks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -16,95 +16,103 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.12.0
 description: 
 email: pat@pathawks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
+- History.markdown
 - LICENSE
-- Rakefile
 - Readme.md
-- jekyll-commonmark.gemspec
 - lib/jekyll-commonmark.rb
-- script/bootstrap
-- script/cibuild
-- script/console
-- script/release
-homepage: https://github.com/pathawks/jekyll-commonmark
+- lib/jekyll-commonmark/html_renderer.rb
+- lib/jekyll-commonmark/version.rb
+homepage: https://github.com/jekyll/jekyll-commonmark
 licenses:
 - MIT
 metadata: {}
@@ -116,15 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: CommonMark generator for Jekyll

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-spec/dest
-.bundle

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.2
-  - 2.1
-  - 2.0
-git:
-  depth: 10
-
-sudo: false
-
-# we need a more recent cmake than travis/linux provides (at least 2.8.9):
-addons:
-  apt:
-    sources:
-      - kalakris-cmake
-    packages:
-      - cmake
-
-before_install:
-  - gem install bundler
-
-before_script: bundle update
-script: script/cibuild

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/jekyll-commonmark.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-
-Gem::Specification.new do |spec|
-  spec.name          = "jekyll-commonmark"
-  spec.summary       = "CommonMark generator for Jekyll"
-  spec.version       = "1.1.0"
-  spec.authors       = ["Pat Hawks"]
-  spec.email         = "pat@pathawks.com"
-  spec.homepage      = "https://github.com/pathawks/jekyll-commonmark"
-  spec.licenses      = ["MIT"]
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "commonmarker", "~> 0.14"
-  spec.add_runtime_dependency "jekyll", [">= 3.0", "< 4.0"]
-
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "bundler", "~> 1.6"
-end

data/script/bootstrap

@@ -1,3 +0,0 @@
-#! /bin/bash
-
-bundle install

data/script/cibuild

@@ -1,3 +0,0 @@
-#! /bin/bash
-
-bundle exec rspec

data/script/console

@@ -1,34 +0,0 @@
-#! /usr/bin/env ruby
-
-def relative_to_root(path)
-  File.expand_path(path, File.dirname(File.dirname(__FILE__)))
-end
-
-require 'jekyll'
-require relative_to_root('lib/jekyll-smartify.rb')
-require 'pry-debugger'
-
-SOURCE_DIR = relative_to_root('spec/fixtures')
-DEST_DIR   = relative_to_root('spec/dest')
-
-def source_dir(*files)
-  File.join(SOURCE_DIR, *files)
-end
-
-def dest_dir(*files)
-  File.join(DEST_DIR, *files)
-end
-
-def config(overrides = {})
-  Jekyll.configuration({
-    "source"      => source_dir,
-    "destination" => dest_dir,
-    "url"         => "http://example.org"
-  }).merge(overrides)
-end
-
-def site(configuration = config)
-  Jekyll::Site.new(configuration)
-end
-
-binding.pry

data/script/release

@@ -1,7 +0,0 @@
-#!/bin/sh
-# Tag and push a release.
-
-set -e
-
-script/cibuild
-bundle exec rake release