kramdown-parser-gfm-extractions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da211446b52c5373ae22fb0ea908fb3250f24352b849e7dac76340d2ec4c49eb
+  data.tar.gz: e34dd49cbdcb77cec604fdcb39b4ab6874cc0b95527322a448135c946689a68a
+SHA512:
+  metadata.gz: 5d2760aad0d74402513b01cb385336dfa701e99b2d474292bf2f6c98f788b7fbf59815ac040ba96fbac91217d468743fc2d7b2f0cabb1d3bdbee880f22c81f12
+  data.tar.gz: a78ec16946531a2fecc3d53c0f3d9f276732ebde158811c53646a134c051796a0c3bf887a94270d157631fe8bd91abd41224ccb2024f80ebc55d218f900a5351

data/.gitignore

@@ -0,0 +1,19 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# main
+
+# 1.0.0 / 2021-04-25
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rouge"
+
+group :test do
+  gem "minitest"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present Jared White and Bridgetown 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 in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,66 @@
+# kramdown-parser-gfm-extractions
+
+A [Kramdown](https://kramdown.gettalong.org) parser extension which provides support for extracting fenced code blocks featuring meta (for example `js script` or `html preview-story`). Useful for supporting the [Markdown JavaScript (mdjs) format](https://rocket.modern-web.dev/docs/markdown-javascript/overview/).
+
+## Installation
+
+Run this command to add the gem to your project's Gemfile.
+
+```
+bundle add kramdown-parser-gfm-extractions
+```
+
+## Usage
+
+Simply require the gem, pass the relevant input option to Kramdown, and you'll get the appropriate HTML output as well as an array of extractions.
+
+~~~ruby
+require "kramdown"
+require "kramdown-parser-gfm-extractions"
+
+text = <<~MD
+  Hello **folks**.
+
+  ```js script
+  import "Foo" from "./bar.js"
+  ```
+
+  ```ruby
+  a = 1 + 2
+  ```
+
+  ```html preview-story
+  <p>I'm a preview!</p>
+  ```
+
+  This is _Markdown!_
+MD
+
+doc = Kramdown::Document.new(text, {input: :GFMExtractions})
+html = doc.to_html
+extractions = doc.root.options[:extractions]
+~~~
+
+In this example, the `js script` block and the `html preview-story` block would both be extracted. In the list of extractions available via `doc.root.options[:extractions]`, you'd obtain hashes with the following keys:
+
+* **lang** - the language code (js, html, etc.)
+* **meta** - the meta string (script, preview-story, etc.)
+* **code** - the actual code block verbatim
+
+By default, the extracted code is still output to the HTML but contained within a custom tag called `kramdown-extraction` containing an inert `template` tag with the rendered output of the syntax processor. If you wish to customize or turn off this behavior, pass these options along to `Kramdown::Document`:
+
+* **include_extraction_tags** - set to `false` to entirely remove the extraction tags
+* **include_code_in_extractions** - set to `false` to strip the rendered code templates out of the extraction tags (but still keep the tags themselves)
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/kramdown-parser-gfm-extractions/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/kramdown-parser-gfm-extractions.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "lib/kramdown-parser-gfm-extractions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kramdown-parser-gfm-extractions"
+  spec.version       = KramdownParserGFMExtractions::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "A subclass of Kramdown's GFM parser which extracts fenced code blocks featuring meta (aka `js script`)"
+  spec.homepage      = "https://github.com/bridgetownrb/kramdown-parser-gfm-extractions"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("kramdown", "~> 2.0")
+  spec.add_dependency("kramdown-parser-gfm", "~> 1.0")
+end

data/lib/kramdown-parser-gfm-extractions.rb

@@ -0,0 +1 @@
+require_relative "kramdown/parser/gfm_extractions"

data/lib/kramdown-parser-gfm-extractions/version.rb

@@ -0,0 +1,3 @@
+module KramdownParserGFMExtractions
+  VERSION = "1.0.0"
+end

data/lib/kramdown/parser/gfm_extractions.rb

@@ -0,0 +1,48 @@
+require "kramdown/parser/gfm"
+require "digest/sha2"
+
+module Kramdown
+  module Parser
+    class GFMExtractions < Kramdown::Parser::GFM
+      FENCED_CODEBLOCK_MATCH = /^[ ]{0,3}(([~`]){3,})\s*?((.+?)(?:\?\S*)?)?\s*?\n(.*?)^[ ]{0,3}\1\2*\s*?\n/m.freeze
+
+      def parse_codeblock_fenced
+        if @src.check(FENCED_CODEBLOCK_MATCH) && @src[3].to_s.strip.include?(" ")
+          @src.pos += @src.matched_size
+          lang = @src[3].to_s.strip
+          lang = lang.split(" ")
+
+          sha = Digest::SHA2.hexdigest(@src[5])
+          @root.options[:extractions] ||= []
+          @root.options[:extractions] << {
+            sha: sha,
+            lang: lang[0],
+            meta: lang[1],
+            code: @src[5]
+          }
+
+          start_line_number = @src.current_line_number
+
+          unless options[:include_extraction_tags] == false
+            el = Element.new(:html_element, "kramdown-extraction", {id: "ex-#{sha}", lang: lang[0], meta: lang[1]}, category: :block, location: start_line_number, content_model: :raw)
+
+            unless options[:include_code_in_extractions] == false
+              code_el = new_block_el(:codeblock, @src[5], nil, location: start_line_number, fenced: true)
+              code_el.options[:lang] = lang[0]
+              code_el.attr['class'] = "language-#{lang[0]}"
+              el.children << Element.new(:html_element, "template", nil, category: :block, location: start_line_number, content_model: :raw).tap do |tmpl|
+                tmpl.children << code_el
+              end
+            end
+
+            @tree.children << el
+          end
+
+          true
+        else
+          super
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-parser-gfm-extractions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kramdown-parser-gfm-extractions.gemspec
+- lib/kramdown-parser-gfm-extractions.rb
+- lib/kramdown-parser-gfm-extractions/version.rb
+- lib/kramdown/parser/gfm_extractions.rb
+homepage: https://github.com/bridgetownrb/kramdown-parser-gfm-extractions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A subclass of Kramdown's GFM parser which extracts fenced code blocks featuring
+  meta (aka `js script`)
+test_files: []