jekyll-commonmark 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 647af3a419ecde37fd6a43f237daac517b22aa12
-  data.tar.gz: b85ba6624adf206e2a6d066b212651d13e413106
+  metadata.gz: c7fa262bbb8c204258512eae201ef6fd2102378c
+  data.tar.gz: 99d43b95c8a8151360285bce64dc6263cc799b15
 SHA512:
-  metadata.gz: 7375fa11944b9dbdac92031ae3393410186b90935fbbdc8a26ca046d6b6c3547c735536bd347c05fe39a6303f3b29b95140839b62fc0405e0aae946f247661db
-  data.tar.gz: 64a551c101c3d84045db1f6c6d193d54729ea87f91792f448aad9d34e40aa13bd0c91cb51cb8c77368901886403115dc8795dc5a5c058270dfec3003d8d5bd41
+  metadata.gz: a80334dc9f6498dddd27e5e84834cf606f839651f0cc0f354bbe95fa867b7f1f81f799d65ce6888aed7e35182fd8a59bb19053c3b114c188e7bf240f96775659
+  data.tar.gz: 2ee960a701c99be7368fd048e1abc6cf1689776168da923b49a3056c682dccdffcc3b7ca15b21bdf0179b27a43eb0c53a4350caf15f319c5f52ada15a0f3b130

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# 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/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - vendor/**/*
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/jekyll-commonmark.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/jekyll-commonmark.rb
+
+Metrics/LineLength:
+  Exclude:
+    - lib/jekyll-commonmark.rb
+
+Lint/Debugger:
+  Exclude:
+    - script/console
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -1,13 +1,13 @@
 language: ruby
 cache: bundler
+sudo: false
 rvm:
+  - 2.5
+  - 2.4
+  - 2.3
   - 2.2
-  - 2.1
-  - 2.0
 git:
-  depth: 10
-
-sudo: false
+  depth: 1
 
 # we need a more recent cmake than travis/linux provides (at least 2.8.9):
 addons:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/History.markdown

@@ -0,0 +1,14 @@
+## 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/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/Readme.md

@@ -3,7 +3,8 @@
 *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)
+[![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.

data/appveyor.yml

@@ -0,0 +1,24 @@
+version: "{build}"
+clone_depth: 5
+build: off
+
+install:
+  - SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
+  - bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
+
+environment:
+  matrix:
+    - RUBY_FOLDER_VER: "24"
+    - RUBY_FOLDER_VER: "24-x64"
+    - RUBY_FOLDER_VER: "23"
+    - RUBY_FOLDER_VER: "22"
+    - RUBY_FOLDER_VER: "21"
+
+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,23 +1,27 @@
-# coding: utf-8
+# 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       = "1.1.0"
+  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.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 "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rubocop", "~> 0.52.0"
 end

data/lib/jekyll-commonmark.rb

@@ -1,5 +1,4 @@
-# Frozen-string-literal: true
-# Encoding: utf-8
+# frozen-string-literal: true
 
 module Jekyll
   module Converters
@@ -7,35 +6,42 @@ module Jekyll
       def initialize(config)
         Jekyll::External.require_with_graceful_fail "commonmarker"
         begin
-          @options = config['commonmark']['options'].collect { |e| e.upcase.to_sym }
+          options = config["commonmark"]["options"].collect { |e| e.upcase.to_sym }
         rescue NoMethodError
-          @options = [:DEFAULT]
+          options = []
         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
+          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 { |e| e.to_sym }
+          @extensions = config["commonmark"]["extensions"].collect(&:to_sym)
         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
+            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_options = :DEFAULT if @parse_options.empty?
+        @render_options = :DEFAULT if @render_options.empty?
       end
 
       def convert(content)
-        CommonMarker.render_doc(content, @options, @extensions).to_html
+        CommonMarker.render_doc(content, @parse_options, @extensions)
+          .to_html(@render_options, @extensions)
       end
     end
   end

data/lib/jekyll-commonmark/version.rb

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

data/script/cibuild

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

data/script/console

@@ -1,15 +1,16 @@
 #! /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'
+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')
+SOURCE_DIR = relative_to_root("spec/fixtures")
+DEST_DIR   = relative_to_root("spec/dest")
 
 def source_dir(*files)
   File.join(SOURCE_DIR, *files)
@@ -23,7 +24,7 @@ def config(overrides = {})
   Jekyll.configuration({
     "source"      => source_dir,
     "destination" => dest_dir,
-    "url"         => "http://example.org"
+    "url"         => "http://example.org",
   }).merge(overrides)
 end
 

data/script/fmt

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

data/spec/jekyll_commonmark_spec.rb

@@ -0,0 +1,90 @@
+# 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

@@ -0,0 +1,12 @@
+# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-commonmark
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pat Hawks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -45,65 +45,87 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.52.0
 description: 
 email: pat@pathawks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- History.markdown
 - LICENSE
 - Rakefile
 - Readme.md
+- appveyor.yml
 - jekyll-commonmark.gemspec
 - lib/jekyll-commonmark.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
 licenses:
 - MIT
@@ -124,8 +146,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: CommonMark generator for Jekyll
-test_files: []
+test_files:
+- spec/jekyll_commonmark_spec.rb
+- spec/spec_helper.rb