jekyll-commonmark 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a192c8c9aa43348774a618188e123dc7d27543c307deb1404cbffd07331928
-  data.tar.gz: d20ef7efbb6f718568a8fa91b8cc4e416a386a250eded43bc8814f0ecdd4b1d2
+  metadata.gz: 1bda6fd984f53c9027917fa0e75046c6962532478d039de9155ac344923d8021
+  data.tar.gz: 675a90e1ef61e9c43481208adb3acba8f949383198a4c28d00f7573d59caf9fb
 SHA512:
-  metadata.gz: 6bfd1ff4f5992203c0ddf2c5f7d6ad62a413ca3e5c8612a36c286a7c8fa8bd1f608826ac1a2977d55d22192f5e5f483ea9b68cd92c2f0fa05ada060652812517
-  data.tar.gz: 0e52a1ff5a1a003c56a7acfe9c41be6446a0281d12e51a352f3f7b9d3bfc66dea05dc630f8ee2ab055ed050a6f3633f24b3e1829429a74fa26058bed8577b196
+  metadata.gz: 0c4d619ba9bea75f6e74e025ecf1b30f5399412cad0567e3f7c1f92e1507b91c325821e51fb40c5986255871992ab31c417ef791b669dd66551992fe2b372d4e
+  data.tar.gz: c13e47638595170762778b8b297dc41a90739161797203300f1f4454720a8743eda74f30cc1665ea5c60e732d2f3f947603f21d796cadb0c9853134e46613bed

data/History.markdown

@@ -1,3 +1,29 @@
+## 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

data/Readme.md

@@ -5,9 +5,8 @@
 [![Gem Version](https://img.shields.io/gem/v/jekyll-commonmark.svg)](https://rubygems.org/gems/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)
-[![Dependency Status](https://img.shields.io/gemnasium/pathawks/jekyll-commonmark.svg)](https://gemnasium.com/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
@@ -36,5 +35,4 @@ To specify [extensions](https://github.com/gjtorikian/commonmarker#extensions) a
 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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module CommonMark
-    VERSION = "1.3.1"
+    VERSION = "1.4.0"
   end
 end

data/lib/jekyll-commonmark.rb

@@ -4,47 +4,61 @@ module Jekyll
   module Converters
     class Markdown
       class CommonMark
+        autoload :HtmlRenderer, "jekyll-commonmark/html_renderer"
+
         def initialize(config)
           Jekyll::External.require_with_graceful_fail "commonmarker"
-          begin
-            options = config["commonmark"]["options"].collect { |e| e.upcase.to_sym }
-          rescue NoMethodError
-            options = []
-          else
-            valid_opts = Set.new(CommonMarker::Config::Parse.keys + CommonMarker::Config::Render.keys)
-            options.reject! do |e|
-              next if valid_opts.include? e
-
-              Jekyll.logger.warn "CommonMark:", "#{e} is not a valid option"
-              Jekyll.logger.info "Valid options:", valid_opts.to_a.join(", ")
-              true
-            end
-          end
-          begin
-            @extensions = config["commonmark"]["extensions"].collect(&:to_sym)
-          rescue NoMethodError
-            @extensions = []
-          else
-            @extensions.reject! do |e|
-              next if 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
 
-          options_set = Set.new(options).freeze
-          @parse_options = (options_set & CommonMarker::Config::Parse.keys).to_a
-          @render_options = (options_set & CommonMarker::Config::Render.keys).to_a
+          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)
 
-          @parse_options = :DEFAULT if @parse_options.empty?
+          @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)
-          CommonMarker.render_doc(content, @parse_options, @extensions)
-            .to_html(@render_options, @extensions)
+          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
+
+        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
+          []
+        end
+
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-commonmark
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Pat Hawks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -16,48 +16,48 @@ 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: jekyll
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,42 +92,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
 description: 
 email: pat@pathawks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/stale.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- Gemfile
 - History.markdown
 - LICENSE
-- Rakefile
 - Readme.md
-- appveyor.yml
-- jekyll-commonmark.gemspec
 - lib/jekyll-commonmark.rb
+- lib/jekyll-commonmark/html_renderer.rb
 - lib/jekyll-commonmark/version.rb
-- script/bootstrap
-- script/cibuild
-- script/console
-- script/fmt
-- script/release
-- spec/jekyll_commonmark_spec.rb
-- spec/spec_helper.rb
-homepage: https://github.com/pathawks/jekyll-commonmark
+homepage: https://github.com/jekyll/jekyll-commonmark
 licenses:
 - MIT
 metadata: {}
@@ -139,17 +124,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: CommonMark generator for Jekyll
-test_files:
-- spec/jekyll_commonmark_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/stale.yml

@@ -1,17 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 60
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-# Label to use when marking an issue as stale
-staleLabel: wontfix
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false

data/.gitignore

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

data/.rubocop.yml

@@ -1,12 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-require: rubocop-jekyll
-
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.3
-  Exclude:
-    - script/**/*
-    - vendor/**/*

data/.rubocop_todo.yml

@@ -1,39 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-01-03 13:58:24 +0100 using RuboCop version 0.62.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: Max.
-Metrics/AbcSize:
-  Exclude:
-    - 'lib/jekyll-commonmark.rb'
-
-# Offense count: 1
-# Configuration parameters: CountComments, Max, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/jekyll_commonmark_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: Max.
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/jekyll-commonmark.rb'
-
-# Offense count: 1
-# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Exclude:
-    - 'lib/jekyll-commonmark.rb'
-
-# Offense count: 1
-# Configuration parameters: CountComments, Max, ExcludedMethods.
-Metrics/MethodLength:
-  Exclude:
-    - 'lib/jekyll-commonmark.rb'

data/.travis.yml

@@ -1,35 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - &latest_ruby 2.6
-  - 2.4
-  - 2.3
-git:
-  depth: 3
-
-# 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 update --system
-  - gem install bundler
-before_script: bundle update
-script: script/cibuild
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  matrix:
-    - JEKYLL_VERSION="~> 3.8"
-
-matrix:
-  include:
-    - rvm: *latest_ruby
-      env: JEKYLL_VERSION="~> 3.7.4"
-    - rvm: *latest_ruby
-      env: JEKYLL_VERSION=">= 4.0.0.pre.alpha1"

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]

data/Rakefile

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

data/appveyor.yml

@@ -1,27 +0,0 @@
-version: "{build}"
-clone_depth: 5
-build: off
-
-install:
-  - SET PATH=C:\Ruby%RUBY_FOLDER_VER%-x64\bin;%PATH%
-  - bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
-
-environment:
-  JEKYLL_VERSION: "~> 3.8"
-  matrix:
-    - RUBY_FOLDER_VER: "26"
-      JEKYLL_VERSION : "~> 3.7.4"
-    - RUBY_FOLDER_VER: "26"
-      JEKYLL_VERSION : ">= 4.0.0.pre.alpha1"
-    - RUBY_FOLDER_VER: "26"
-    - RUBY_FOLDER_VER: "24"
-    - RUBY_FOLDER_VER: "23"
-
-test_script:
-  - ruby --version
-  - gem --version
-  - bundler --version
-  - bash script/cibuild
-
-cache:
-  - 'vendor\bundle -> appveyor.yml,Gemfile,jekyll-commonmark.gemspec'

data/jekyll-commonmark.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("lib", __dir__)
-require "jekyll-commonmark/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "jekyll-commonmark"
-  spec.summary       = "CommonMark generator for Jekyll"
-  spec.version       = Jekyll::CommonMark::VERSION
-  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.required_ruby_version = ">= 2.3.0"
-
-  spec.add_runtime_dependency "commonmarker", "~> 0.14"
-  spec.add_runtime_dependency "jekyll", ">= 3.7", "< 5.0"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.5"
-end

data/script/bootstrap

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

data/script/cibuild

@@ -1,4 +0,0 @@
-#! /bin/bash
-
-script/fmt
-bundle exec rspec

data/script/console

@@ -1,35 +0,0 @@
-#! /usr/bin/env ruby
-# frozen_string_literal: true
-
-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/fmt

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-echo "Rubocop $(bundle exec rubocop --version)"
-bundle exec rubocop -D -E $@

data/script/release

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

data/spec/jekyll_commonmark_spec.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe(Jekyll::Converters::Markdown::CommonMark) do
-  let(:options) { [] }
-  let(:extensions) { [] }
-  let(:config) do
-    {
-      "commonmark" => {
-        "options"    => options,
-        "extensions" => extensions,
-      },
-    }
-  end
-  let(:commonmark) { described_class.new(config) }
-  let(:output) { commonmark.convert(content) }
-
-  context "with default configuration" do
-    it "produces the correct script tag" do
-      actual = commonmark.convert("# Heading")
-      expected = "<h1>Heading</h1>"
-      expect(actual).to match(expected)
-    end
-
-    it "does not treat newlines as hardbreaks" do
-      actual = commonmark.convert("a\nb")
-      expected = "<p>a\nb</p>"
-      expect(actual).to match(expected)
-    end
-
-    it "treats double linebreaks as a new paragraph" do
-      actual = commonmark.convert("a\n\nb")
-      expected = "<p>a</p>\n<p>b</p>"
-      expect(actual).to match(expected)
-    end
-
-    it "escapes quotes" do
-      actual = commonmark.convert('"SmartyPants"')
-      expected = "<p>&quot;SmartyPants&quot;</p>"
-      expect(actual).to match(expected)
-    end
-
-    it "does not link urls" do
-      actual = commonmark.convert("https://example.com")
-      expected = "https://example.com"
-      expect(actual).to match(expected)
-    end
-  end
-
-  context "with SmartyPants enabled" do
-    let(:options) { ["SMART"] }
-
-    it "makes quotes curly" do
-      actual = commonmark.convert('"SmartyPants"')
-      expected = "<p>“SmartyPants”</p>"
-      expect(actual).to match(expected)
-    end
-  end
-
-  context "with hardbreaks enabled" do
-    let(:options) { ["HARDBREAKS"] }
-
-    it "treats newlines as hardbreaks" do
-      actual = commonmark.convert("a\nb")
-      expected = "<p>a<br />\nb</p>"
-      expect(actual).to match(expected)
-    end
-  end
-
-  context "with nobreaks enabled" do
-    let(:options) { ["NOBREAKS"] }
-
-    it "treats newlines as a single space" do
-      actual = commonmark.convert("a\nb")
-      expected = "<p>a b</p>"
-      expect(actual).to match(expected)
-    end
-  end
-
-  context "with autolink enabled" do
-    let(:extensions) { ["autolink"] }
-
-    it "links urls" do
-      actual = commonmark.convert("https://example.com")
-      expected = '<p><a href="https://example.com">https://example.com</a></p>'
-      expect(actual).to match(expected)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll-commonmark.rb"
-
-Jekyll.logger.log_level = :info
-
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = "random"
-end