commonmarker-pluggable 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa4b2bb80b5f12bd72456d32c883de8fb976bead241c346861a84dc4ee7ec29b
+  data.tar.gz: c71b2ad1322a6a834937d4b9e268e6ad44d4fa83bff803907201cd3b4fd8e933
+SHA512:
+  metadata.gz: 1ad84469f15a6319e5b7333b4d11471109105c59e261389d99b7ae673dfeb365a088d25ba60494d49c2987e3c7f58bf9c5d339dfe4ee0c39595ae90bf7965526
+  data.tar.gz: 0d5d04b17eb6d7e65262d58338a2a0747a84d5350600622f721a041f210b07f1c6fb3a518cd76d99d73239e14ea84835441d5fcf979f9b107858ad9f7d422b95

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_commands/
+/_site/
+/_yardoc/
+/backup/
+/blog/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/vendor/
+/tmp/
+*.swp
+.jekyll-metadata
+.sass-cache/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in taipo.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
+software, either in source code form or as a compiled binary, for any purpose,
+commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and to
+the detriment of our heirs and successors. We intend this dedication to be an
+overt act of relinquishment in perpetuity of all present and future rights to
+this software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,98 @@
+[![Gem Version][badge-img]][badge-link]
+
+[badge-img]: https://badge.fury.io/rb/commonmarker-pluggable.svg
+[badge-link]: https://badge.fury.io/rb/commonmarker-pluggable
+
+# commonmarker-pluggable
+
+commonmarker-pluggable adds support for plugins to CommonMarker.
+
+The `cmark` reference parser used by CommonMarker supports extensions to the
+CommonMark specification but these are written in C. The commonmarker-pluggable
+plugin allows users to extend CommonMarker's parsing capabilities with plugins
+written in Ruby.
+
+## Installation
+
+The commonmarker-pluggable plugin requires the commonmarker plugin to
+be installed and configured ([instructions here][cmp]). The only additional
+step is to add commonmarker-pluggable to your `Gemfile` like so:
+
+[cmp]: https://github.com/gjtorikian/commonmarker
+
+```ruby
+gem 'commonmarker'
+gem 'commonmarker-pluggable'
+```
+
+## Writing Plugins
+
+Once commonmarker-pluggable is installed, you can add plugins that manipulate
+the Markdown document parsed by `cmark`.
+
+Plugins are automatically detected by commonmark-pluggable if they are within
+the `Commonmarker::Plugin` namespace as demonstrated below. Please note that the
+plugin itself must be of type `Module`.
+
+A plugin must implement the `self.call()` module method. This method takes one
+argument: `doc`. This is a `CommonMarker::Node` object representing the
+top-most node of a parsed Markdown document.
+
+An example plugin is set out below:
+
+```ruby
+module CommonMarker
+  module Plugin
+    module Example
+      def self.call(doc)
+        doc.walk do |node|
+          node.delete if node.string_content == 'To be deleted'
+        end
+      end
+    end
+  end
+end
+```
+
+## Using with Jekyll
+
+commonmarker-pluggable was originally written for use with Jekyll. If you want
+to write a plugin that is both a CommonMarker plugin _and_ a Jekyll plugin, you
+need to ensure that commonmarker-pluggable is installed as a Jekyll plugin.
+There are [other ways][jk-pl] to do this, but the easiest method is to include
+commonmarker-pluggable in the `:jekyll_plugins` group in your Gemfile:
+
+[jk-pl]: https://jekyllrb.com/docs/plugins/installation/
+
+```ruby
+group :jekyll_plugins do
+  gem 'commonmarker-pluggable'
+  gem 'jekyll-commonmark'
+  ...
+end
+```
+
+## Bugs
+
+Found a bug? I'd love to know about it. The best way is to report them in the
+[Issues section][gh-i] on GitHub.
+
+[gh-i]: https://github.com/pyrmont/commonmarker-pluggable/issues
+
+## Contributing
+
+If you're interested in contributing to commonmarker-pluggable, feel free to
+fork and submit a pull request.
+
+## Versioning
+
+The commonmarker-pluggable plugin uses [Semantic Versioning 2.0.0][sv2].
+
+[sv2]: http://semver.org/
+
+## Licence
+
+The commonmarker-pluggable plugin is released into the public domain. See
+[LICENSE.md][lc] for more details.
+
+[lc]: https://github.com/pyrmont/commonmarker-pluggable/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/commonmarker-pluggable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commonmarker-pluggable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "commonmarker-pluggable"
+  spec.version       = CommonMarkerPluggable::VERSION
+  spec.authors       = ["Michael Camilleri"]
+  spec.email         = ["mike@inqk.net"]
+
+  spec.summary       = %q{A plugin that extends commonmarker to support plugins}
+  spec.description   = %q{The commonmarker-pluggable plugin provides a simple way to extend the CommonMark parser using plugins.}
+  spec.homepage      = "https://github.com/pyrmont/commonmarker-pluggable/"
+  spec.license       = "Unlicense"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.add_dependency "commonmarker", "~> 0.20"
+end

data/lib/commonmarker-pluggable.rb

@@ -0,0 +1,38 @@
+# frozen-string-literal: true
+
+require 'commonmarker'
+
+# An extension to CommonMarker that adds plugin support
+#
+# CommonMarkerPluggable is a shim that adds itself to CommonMarker and
+# intercepts calls to `CommonMarker.render_doc`. After a document object is
+# created, CommonMarkerPluggable calls the `.call` method of each plugin,
+# passing the updated document object each time.
+#
+# @since 0.2.0
+# @see https://github.com/pyrmont/jekyll-commonmarker-pluggable
+module CommonMarkerPluggable
+
+  # Collect the plugins
+  #
+  # @since 0.2.0
+  def self.plugins
+    @plugins ||= CommonMarker::Plugin.constants.reduce(Array.new) do |total,c|
+                   next total unless (m = CommonMarker::Plugin.const_get(c)).is_a? Module
+                   total.push m
+                 end
+  end
+
+  # Render the CommonMark document
+  #
+  # @since 0.2.0
+  def render_doc(text, options = :DEFAULT, extensions = [])
+    doc = super(text, options, extensions)
+    CommonMarkerPluggable.plugins.each do |plugin|
+      plugin.call doc
+    end
+    doc
+  end
+end
+
+CommonMarker.singleton_class.prepend CommonMarkerPluggable

data/lib/commonmarker-pluggable/version.rb

@@ -0,0 +1,3 @@
+module CommonMarkerPluggable
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: commonmarker-pluggable
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Michael Camilleri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: The commonmarker-pluggable plugin provides a simple way to extend the
+  CommonMark parser using plugins.
+email:
+- mike@inqk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- commonmarker-pluggable.gemspec
+- lib/commonmarker-pluggable.rb
+- lib/commonmarker-pluggable/version.rb
+homepage: https://github.com/pyrmont/commonmarker-pluggable/
+licenses:
+- Unlicense
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A plugin that extends commonmarker to support plugins
+test_files: []