kramdown-asciidoc 1.0.0.alpha.12 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64f9079115320afb426fbb449cd0b6163b49fbdeb7ae2dc07407eb37524c787a
-  data.tar.gz: e2b4a086c0ec8248970d4d8f121b9642b8a9665510b69fe658f9311a7f96fa2f
+  metadata.gz: be0108c05d441dbc4125ed5fa6f51d152ae238d769cf5add12a0c35000c237e4
+  data.tar.gz: 77fec67f63c28cb7611c45aaca839292cb19686e8d9e02cd87ed31a129fd939a
 SHA512:
-  metadata.gz: 2a537db76f1c5406c9a991e442fa366a121907c3b3aeb813434da304f2ec37d0773c1a91b72224ff2ab28f7ad8bc8f9884c842dce0d4228f31a44f4aca889a9e
-  data.tar.gz: fd86b40db1f4f2b22d99ae6295a8a78173f0e8039045224306b143f1d6fd96e00e384c6d9fea4873ccad4616771fa29a96b8cb01005e129315d19c729b7a8cb6
+  metadata.gz: 309476de155735f63f125bf1c91349f2d261b02c4e69b0ca5e154381893ec6d340429f348d14dd42e08ec4039db7d531a5de36e13089ee2e4ff9609696e161a7
+  data.tar.gz: e4e265aae1a393d0f1b2038bce02aae9ffaa24d4b8e219458bf557ff219c3629c27d9788a9b1a69115d1e1522b60ec28d3771884cc68c2cfc4dbfa52f15f35b0

data/CHANGELOG.adoc

@@ -5,6 +5,100 @@
 This document provides a high-level view of the changes to {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 (2021-07-11) - @mojavelinux
+
+=== Added
+
+* Add support for converting block LaTeX math to stem block
+* Add support for converting span LaTeX math to inline stem macro
+* Add basic support for footnotes (#74)
+
+=== Fixed
+
+* Use File.read instead of IO.read to suppress magic subprocess behavior
+* Enable compatibility with Ruby 3 by declaring rexml as a runtime dependency (#84)
+* Don't crash when converting list item that only contains spaces (#83)
+
+=== Changed
+
+* Upgrade kramdown to 2.3.x and declare kramdown-parser-gfm as runtime dependency (#85)
+* Don't add source style to listing block when language is specified
+* Switch CI to GitHub Actions
+* Run test suite in CI environment on Windows and macOS
+* Apply style rules to source code
+
+=== Details
+
+{uri-repo}/releases/tag/v2.0.0[git tag] | {uri-repo}/compare/v1.0.1\...v2.0.0[full diff]
+
+== 1.0.1 (2018-11-28) - @mojavelinux
+
+=== Fixed
+
+* Fixed bin script on Ruby 2.3 (#70)
+
+=== Details
+
+{uri-repo}/releases/tag/v1.0.1[git tag] | {uri-repo}/compare/v1.0.0\...v1.0.1[full diff]
+
+== 1.0.0 (2018-11-07) - @mojavelinux
+
+=== Changed
+
+* change CLI to use default options from API
+
+=== Fixed
+
+* automatically require version file so -v CLI flag reports correct version
+
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0[git tag] | {uri-repo}/compare/v1.0.0.rc.1\...v1.0.0[full diff]
+
+== 1.0.0.rc.1 (2018-11-06) - @mojavelinux
+
+=== Added
+
+* ventilate prose on semi-colon following non-space character
+* add :preprocessors option to convert API; apply default preprocessors if not set; apply none if falsy (#23)
+* add :postprocessors option to convert API; takes precedence over :postprocess option (#67)
+* accept IO object as input to convert method (#49)
+* accept File object as input to convert_file method (#49)
+* add API docs to public API methods
+
+=== Changed
+
+* remove whitespace in front of leading XML comment (so a block comment isn't mistaken for an inline comment)
+* drop empty XML comment unless it comes after a list
+
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.rc.1[git tag] | {uri-repo}/compare/v1.0.0.alpha.13\...v1.0.0.rc.1[full diff]
+
+== 1.0.0.alpha.13 (2018-08-21) - @mojavelinux
+
+=== Added
+
+* drop ID on section title if matches auto-generated value when :lazy_ids API option / --lazy-ids CLI option is set (#16)
+* auto-generate IDs for section titles when :auto_ids option is set and :input is not GFM
+* add :postprocess callback option to `convert` and `convert_file` API methods (#53)
+
+=== Changed
+
+* automatically set idprefix, if necessary, based on value of :auto_id_prefix option when :auto_ids options is set (#16)
+* don't modify value of :attributes option passed to `convert` and `convert_file` API methods
+* define ID containing a dot using longhand attribute assignment (#59)
+* extract raw text consistently regardless of input flavor (#56)
+* sort attributes in document header (#55)
+
+=== Fixed
+
+* enclose codeblock content in literal block delimiters if content starts with a list marker (#57)
+
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.13[git tag] | {uri-repo}/compare/v1.0.0.alpha.12\...v1.0.0.alpha.13[full diff]
+
 == 1.0.0.alpha.12 (2018-08-11) - @mojavelinux
 
 === Added
@@ -23,6 +117,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * break on all terminal punctuation (period, question mark, and exclamation mark) when ventilating prose (#51)
 * consolidated logic in CLI by further delegating to API
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.12[git tag] | {uri-repo}/compare/v1.0.0.alpha.11\...v1.0.0.alpha.12[full diff]
+
 == 1.0.0.alpha.11 (2018-08-02) - @mojavelinux
 
 === Added
@@ -42,6 +140,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * use unconstrained codespan if bounded on either side by a smart quote
 * ignore auto-generated ID if heading has an explicit inline anchor
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.11[git tag] | {uri-repo}/compare/v1.0.0.alpha.10\...v1.0.0.alpha.11[full diff]
+
 == 1.0.0.alpha.10 (2018-07-16) - @mojavelinux
 
 === Added
@@ -60,6 +162,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 
 * insert blank line above list continuation to attach to parent list item (#27)
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.10[git tag] | {uri-repo}/compare/v1.0.0.alpha.9\...v1.0.0.alpha.10[full diff]
+
 == 1.0.0.alpha.9 (2018-07-10) - @mojavelinux
 
 === Changed
@@ -69,6 +175,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * don't add newline after period at start of line when producing ventilated prose
 * use :imagesdir API option or --imagesdir CLI option to set implicit imagesdir instead of attribute
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.9[git tag] | {uri-repo}/compare/v1.0.0.alpha.8\...v1.0.0.alpha.9[full diff]
+
 == 1.0.0.alpha.8 (2018-07-03) - @mojavelinux
 
 === Added
@@ -80,6 +190,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * don't escape double hyphen in codespan unless surrounded by spaces or word chars
 * treat leading specialchar (<, >, or &) as a word character (since it gets converted to a char reference)
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.8[git tag] | {uri-repo}/compare/v1.0.0.alpha.7\...v1.0.0.alpha.8[full diff]
+
 == 1.0.0.alpha.7 (2018-07-02) - @mojavelinux
 
 === Added
@@ -100,6 +214,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * replace .md extension with .adoc in text of interdoc xref
 * replace a non-breaking space with a single space instead of \{nbsp}
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.7[git tag] | {uri-repo}/compare/v1.0.0.alpha.6\...v1.0.0.alpha.7[full diff]
+
 == 1.0.0.alpha.6 (2018-06-26) - @mojavelinux
 
 === Added
@@ -116,6 +234,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * use writer to track list nesting level
 * fix warnings
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.6[git tag] | {uri-repo}/compare/v1.0.0.alpha.5\...v1.0.0.alpha.6[full diff]
+
 == 1.0.0.alpha.5 (2018-06-19) - @mojavelinux
 
 === Added
@@ -131,6 +253,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * use separate list level for dl
 * fold description list item to one line if primary text is a single line
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.5[git tag] | {uri-repo}/compare/v1.0.0.alpha.4\...v1.0.0.alpha.5[full diff]
+
 == 1.0.0.alpha.4 (2018-06-12) - @mojavelinux
 
 === Added
@@ -156,6 +282,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * upgrade kramdown to 1.17.0
 * use correct casing for kramdown in README and library metadata
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.4[git tag] | {uri-repo}/compare/v1.0.0.alpha.3\...v1.0.0.alpha.4[full diff]
+
 == 1.0.0.alpha.3 (2018-05-31) - @mojavelinux
 
 === Added
@@ -169,6 +299,10 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 
 * replace ndash symbol with \-- instead of \&#8211;
 
+=== Details
+
+{uri-repo}/releases/tag/v1.0.0.alpha.3[git tag] | {uri-repo}/compare/v1.0.0.alpha.2\...v1.0.0.alpha.3[full diff]
+
 == 1.0.0.alpha.2 (2018-05-24) - @mojavelinux
 
 === Added
@@ -195,8 +329,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 
 === Details
 
-{uri-repo}/releases/tag/v1.0.0.alpha.2[git tag] |
-{uri-repo}/compare/v1.0.0.alpha.1...v1.0.0.alpha.2[full diff]
+{uri-repo}/releases/tag/v1.0.0.alpha.2[git tag] | {uri-repo}/compare/v1.0.0.alpha.1\...v1.0.0.alpha.2[full diff]
 
 == 1.0.0.alpha.1 (2018-05-22) - @mojavelinux
 

data/Gemfile

@@ -1,8 +1,23 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+without = (Bundler.settings['WITHOUT'] || '').split ':'
+
+group :docs do
+  gem 'asciidoctor', require: false
+  gem 'yard', require: false
+end unless without.include? 'docs'
+
+group :lint do
+  gem 'rubocop', '~> 1.18.0', require: false
+  gem 'rubocop-rake', '~> 0.6.0', require: false
+  gem 'rubocop-rspec', '~> 2.4.0', require: false
+end unless without.include? 'lint'
+
 group :coverage do
-  gem 'deep-cover', git: 'https://github.com/mojavelinux/deep-cover', branch: 'no-cli', require: false
-  gem 'sass', require: false unless ENV['CI']
-end
+  gem 'deep-cover-core', '~> 1.1.0', require: false
+  gem 'simplecov', '~> 0.21.0', require: false
+end unless without.include? 'coverage'

data/LICENSE.adoc

@@ -1,6 +1,6 @@
 .The MIT License
 ....
-Copyright (C) 2016 OpenDevise Inc. (on behalf of the Asciidoctor Project)
+Copyright (C) 2016-2019 OpenDevise Inc. (on behalf of the Asciidoctor Project)
 
 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.adoc

@@ -1,6 +1,6 @@
 = {project-name} (Markdown to AsciiDoc)
 Dan Allen <https://github.com/mojavelinux>
-v1.0.0.alpha.12, 2018-08-11
+v2.0.0, 2021-07-11
 // Aliases:
 :project-name: Kramdown AsciiDoc
 :project-handle: kramdown-asciidoc
@@ -19,47 +19,43 @@ ifdef::env-github[]
 :tip-caption: :bulb:
 endif::[]
 // URIs:
-:uri-repo: https://github.com/asciidoctor/kramdown-asciidoc
-:uri-asciidoc: https://asciidoctor.org/docs/what-is-asciidoc/#what-is-asciidoc
-:uri-asciidoctor: https://asciidoctor.org
-:uri-kramdown: https://kramdown.gettalong.org
-:uri-rvm: https://rvm.io
-:uri-rvm-install: https://rvm.io/rvm/install
-:uri-ci-appveyor: https://ci.appveyor.com/project/asciidoctor/kramdown-asciidoc
-:img-ci-appveyor: https://ci.appveyor.com/api/projects/status/2pwvdbcoeux1ifb5/branch/master?svg=true
-:uri-ci-travis: https://travis-ci.org/asciidoctor/kramdown-asciidoc
-:uri-ci-travis-img: https://img.shields.io/travis/asciidoctor/kramdown-asciidoc/master.svg
-:uri-gem: https://rubygems.org/gems/kramdown-asciidoc
-:uri-gem-img: https://img.shields.io/gem/v/kramdown-asciidoc.svg?label=gem
+:url-repo: https://github.com/asciidoctor/kramdown-asciidoc
+:url-asciidoc: https://asciidoctor.org/docs/what-is-asciidoc/#what-is-asciidoc
+:url-asciidoctor: https://asciidoctor.org
+:url-kramdown: https://kramdown.gettalong.org
+:url-rvm: https://rvm.io
+:url-rvm-install: https://rvm.io/rvm/install
+:url-api-docs: https://www.rubydoc.info/github/asciidoctor/kramdown-asciidoc/master
+:url-gem: https://rubygems.org/gems/kramdown-asciidoc
+:img-url-gem: https://img.shields.io/gem/v/kramdown-asciidoc.svg?label=gem
 
 ifdef::status[]
-image:{uri-gem-img}[Gem Version,link={uri-gem}]
-image:{uri-ci-travis-img}[Build Status (Travis CI),link={uri-ci-travis}]
-image:{img-ci-appveyor}[Build Status (AppVeyor),link={uri-ci-appveyor}]
+image:{img-url-gem}[Gem Version,link={url-gem}]
+image:{url-repo}/workflows/CI/badge.svg[Build Status (GitHub Actions),link={url-repo}/actions?query=workflow%3ACI+branch%3Amain]
 endif::[]
 
-{uri-repo}[{project-name}] (gem: *{project-handle}*) is a {uri-kramdown}[kramdown] extension for converting Markdown documents to {uri-asciidoc}[AsciiDoc].
-Notably, the converter generates modern AsciiDoc syntax suitable for use with {uri-asciidoctor}[Asciidoctor].
+{url-repo}[{project-name}] (gem: *{project-handle}*, command: `kramdoc`) is a {url-kramdown}[kramdown] extension for converting Markdown documents to {url-asciidoc}[AsciiDoc].
+Notably, the converter generates modern AsciiDoc syntax suitable for use with {url-asciidoctor}[Asciidoctor].
 
 == Prerequisites
 
-To install and run {project-name}, you need Ruby 2.4 or better installed and a few RubyGems (aka gems).
-We'll explain how to install the gems in the next section.
+To install and run {project-name}, you need Ruby 2.3 or better installed and a few RubyGems (aka gems).
+The instructions for installing the gems is covered in the next section.
 
 To check whether you have Ruby installed, and which version, run the following command:
 
  $ ruby -v
 
-If Ruby is not installed, you can install it using {uri-rvm}[RVM] (or, if you prefer, the package manager for your system).
+If Ruby is not installed, you can install it using {url-rvm}[RVM] (or, if you prefer, the package manager for your system).
 We generally recommend using RVM because it allows you to install gems without requiring elevated privileges or messing with system libraries.
 
 == Installation
 
-{project-name} is published to RubyGems.org as a pre-release gem named *{project-handle}*.
+{project-name} is published to RubyGems.org as a gem named *{project-handle}*.
 
-You can install the pre-release version using the following command:
+You can install the latest version of the gem using the following command:
 
- $ gem install kramdown-asciidoc --pre
+ $ gem install kramdown-asciidoc
 
 Installing this gem makes the `kramdoc` command available on your $PATH.
 
@@ -90,9 +86,9 @@ To see all the options the `kramdoc` command accepts, pass the `-h` option to th
 
 For example, you can inject attributes (key/value pairs) into the header of the AsciiDoc output document using the `-a` option.
 
- $ kramdoc -a product-name="ACME Cloud" -a hide-uri-scheme sample.md
+ $ kramdoc -a product-name="ACME Cloud" -a hide-url-scheme sample.md
 
-Another use for attributes is setting the shared images directory, which is coverd in the next section.
+Another use for attributes is setting the shared images directory, which is covered in the next section.
 
 == Configure shared images directory
 
@@ -136,17 +132,42 @@ image::octocat.png[Octocat]
 
 In this scenario, you may need to pass the `imagesdir` attribute to the AsciiDoc processor when converting the output document so the image is resolved, depending on where the image is stored.
 
+== Auto-generate IDs
+
+You can configure kramdoc to automatically generate explicit IDs for each section title (aka heading) that doesn't already have an ID assigned to it (in the Markdown source).
+To do so, simply enable the `--auto-ids` flag:
+
+ $ kramdoc --auto-ids sample.md
+
+By default, kramdoc does not add a prefix to the generated ID and uses `-` as the separator / replacement character.
+You can change these values using the `--auto-id-prefix` and `--auto-id-separator` options, respectively:
+
+ $ kramdoc --auto-ids --auto-id-prefix=_ --auto-id-separator=_ sample.md
+
+Since the AsciiDoc processor generates an ID for any section title that doesn't have one by default, you may decide you want to drop any ID which matches its auto-generated value.
+You can enable this behavior by adding the `--lazy-ids` flag:
+
+ $ kramdoc --lazy-ids sample.md
+
+The catch is that kramdown/kramdoc and AsciiDoc don't use the same prefix and separator when generating IDs.
+So it's necessary to sync them.
+The simplest way is to set the `--auto-id-prefix` and `--auto-id-separator` values to match those used by AsciiDoc.
+
+ $ kramdoc --lazy-ids --auto-id-prefix=_ --auto-id-separator=_ sample.md
+
+If these values do not match the defaults in AsciiDoc, the `idprefix` and/or `idseparator` attributes will be assigned explicitly in the generated document.
+
 == API
 
-In additional to the command-line interface, {project-name} also provides a porcelain API.
+In additional to the command-line interface, {project-name} also provides a porcelain API (see {url-api-docs}[API docs]).
 We use the term "`porcelain`" because the API hides the details of registering the converter, preprocessing the Markdown document, parsing the document with kramdown, and calling the converter method to transform the parse tree to AsciiDoc.
 
-The API consists of two static methods:
+The API consists of two static methods in the Kramdoc module:
 
-* `Kramdoc.convert(source, opts)` - convert a Markdown string to AsciiDoc
-* `Kramdoc.convert_file(file, opts)` - convert a Markdown file to AsciiDoc
+* `Kramdoc.convert(source, opts)` - convert a Markdown string or IO object to AsciiDoc
+* `Kramdoc.convert_file(file, opts)` - convert a Markdown file object or path to AsciiDoc
 
-NOTE: `Kramdoc` is shorthand for `Kramdown::AsciiDoc` to align with the name of the CLI.
+NOTE: `Kramdoc` is a shorthand for `Kramdown::AsciiDoc` to align with the name of the CLI.
 
 Both API methods accept the source as the first argument and an options hash as the second.
 
@@ -194,6 +215,8 @@ Kramdoc.convert markdown, to: 'result.adoc'
 
 The input string is automatically converted to UTF-8.
 
+For more information about the API, refer to the {url-api-docs}[API documentation].
+
 == Development
 
 To help develop {project-name}, or to simply test-drive the development version, you need to retrieve the source from GitHub.
@@ -201,10 +224,10 @@ Follow the instructions below to learn how to clone the source and run the appli
 
 === Retrieve the source code
 
-Simply copy the {uri-repo}[GitHub repository URL] and pass it to the `git clone` command:
+Simply copy the {url-repo}[GitHub repository URL] and pass it to the `git clone` command:
 
 [subs=attributes+]
- $ git clone {uri-repo}
+ $ git clone {url-repo}
 
 Next, switch to the project directory:
 
@@ -213,9 +236,9 @@ Next, switch to the project directory:
 
 === Prepare RVM (optional)
 
-We recommend using {uri-rvm}[RVM] when developing applications with Ruby.
+We recommend using {url-rvm}[RVM] when developing applications with Ruby.
 We like RVM because it keeps the dependencies required by the project isolated from the rest of your system.
-Follow the {uri-rvm-install}[installation instructions] on the RVM site to setup RVM and install Ruby.
+Follow the {url-rvm-install}[installation instructions] on the RVM site to setup RVM and install Ruby.
 
 Once you have RVM setup, switch to the RVM-managed version of Ruby recommended by the project using this command:
 
@@ -242,7 +265,7 @@ Then, use the `bundle` command to install the project dependencies under the pro
 
 NOTE: You must invoke `bundle` from the project's root directory so it can locate the [.path]_Gemfile_.
 
-=== Run the Tests
+=== Run the tests
 
 The test suite is located in the [.path]_spec_ directory.
 The tests are all based on RSpec.
@@ -264,7 +287,7 @@ To run all the scenarios, point RSpec at the spec file:
 
  $ bundle exec rspec spec/scenario_spec.rb
 
-==== Run Individual Tests
+==== Run individual tests
 
 If you only want to run a single test, or a group of tests, you can do so by tagging the test cases, then filtering the test run using that tag.
 
@@ -291,6 +314,40 @@ Run RSpec with the example filter:
 
 RSpec will only run the specifications that have a description containing the text `wrap`.
 
+=== Generate code coverage
+
+To generate a code coverage report when running tests using simplecov, set the `COVERAGE` environment variable as follows when running the tests:
+
+ $ COVERAGE=true bundle exec rake
+
+You'll see a total coverage score as well as a link to the HTML report in the output.
+The HTML report helps you understand which lines and branches were missed, if any.
+
+Despite being fast, the downside of using simplecov is that it misses branches.
+You can use deep-cover to generate a more thorough report.
+To do so, set the `COVERAGE` environment variable as follows when running the tests:
+
+ $ COVERAGE=deep bundle exec rake
+
+You'll see a total coverage score, a detailed coverage report, and a link to HTML report in the output.
+The HTML report helps you understand which lines and branches were missed, if any.
+
+As an alternative to deep cover's native HTML reporter, you can also use istanbul / nyc.
+First, you'll need to have the `nyc` command available on your system:
+
+ $ npm install -g nyc
+
+or
+
+ $ yarn global add nyc
+
+Next, in addition to the `COVERAGE` environment variable, also set the `DEEP_COVER_REPORTER` environment variable as follows when running the tests:
+
+ $ COVERAGE=deep DEEP_COVER_REPORTER=istanbul bundle exec rake
+
+You'll see a total coverage score, a detailed coverage report, and a link to HTML report in the output.
+The HTML report helps you understand which lines and branches were missed, if any.
+
 === Usage
 
 When running the `kramdoc` command from source, you must prefix the command with `bundle exec`:
@@ -310,7 +367,7 @@ To avoid having to do this, or make the `kramdoc` command available from anywher
 
 == Copyright
 
-Copyright (C) 2016-2018 OpenDevise Inc. (on behalf of the Asciidoctor Project).
+Copyright (C) 2016-2019 OpenDevise Inc. (on behalf of the Asciidoctor Project).
 Free use of this software is granted under the terms of the MIT License.
 
 See the link:LICENSE.adoc[LICENSE] file for details.