kramdown-components 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d12fd7ba367f8b2ff86e9e6d313781b88757b37c456a94654ade598c0b47df41
+  data.tar.gz: 7a02bd99bce593452e2d3f510718b474a1acc894c730d66e1f9eba07ecd3e0bd
+SHA512:
+  metadata.gz: 6db57afee5989ac53ab2cd7b1668e9f110fd88e1da20195f724a218c4d59530487ed8bd095267441e9805b046a321530118c53382bed55783df63fc5e7bbbf39
+  data.tar.gz: e86b0cd86885dce1175a6384b03f037f39d32cc962e1d5ad176f37604e38008a0f884f125f150fc119f6fd2f1ab34fe4234ac532b6fbe549bbdb0e2cdc4b5589

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    kramdown-components (0.0.1)
+      kramdown (~> 2.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    kramdown (2.4.0)
+      rexml
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  bundler
+  kramdown-components!
+  rspec
+
+BUNDLED WITH
+   2.2.9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Mark Rickerby
+
+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,31 @@
+# Kramdown Components
+
+Rewrite sections of Markdown documents using HTML Custom Elements.
+
+Useful for enhancing code blocks and formatted markup with more sophisticated controls while maintaining a clean separation of presentation and content.
+
+## How it Works
+
+Register new components for your documents. Use the custom elements as block level wrappers in your text markup. Mix and match HTML and Markdown syntax. Generate nested DOM trees from a single top level element.
+
+This library is only responsible for converting HTML elements at compile time. To actually render and control the element lifecycle when your document is viewed in a browser, you will need to attach the appropriate JavaScript.
+
+## Usage
+
+To use the enhanced documents with components, create a `CustomDocument` instance. This supports  the same interface as the base `Kramdown::Document`.
+
+```ruby
+require "kramdown-components"
+
+doc = Kramdown::CustomDocument("# Title")
+
+puts doc.to_html
+```
+
+### Registration Phase
+
+```rb
+
+```
+
+### Compile Phase

data/kramdown-components.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |spec|
+  spec.name = "kramdown-components"
+  spec.version = "0.0.1"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "Rewrite sections of Markdown documents using HTML Custom Elements."
+  spec.description = "Mix and match HTML and Markdown syntax. Generate nested DOM trees from a single top level element."
+  spec.authors = ["Mark Rickerby"]
+  spec.email = "me@maetl.net"
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.add_runtime_dependency "kramdown", '~> 2.4.0'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+  #spec.add_development_dependency "rspec-html"
+  spec.homepage = "https://github.com/maetl/kramdown-components"
+  spec.license = "MIT"
+end

data/lib/kramdown/custom_document.rb

@@ -0,0 +1,102 @@
+require "kramdown"
+
+module Kramdown
+  class CustomDocument
+    def self.define_element(name, element=nil)
+      if element.nil?
+        element = CustomElement
+      end
+      tag_name = name.downcase
+      Kramdown::Parser::Html::Constants::HTML_ELEMENT[tag_name] = true
+      Kramdown::Parser::Html::Constants::HTML_CONTENT_MODEL[tag_name] = :block
+      @@custom_elements ||= {}
+      @@custom_elements[tag_name] = element
+    end
+
+    attr_reader :custom_elements
+
+    def initialize(source)
+      @source = source
+      @parsed_dom = Kramdown::Document.new(@source, {
+        input: "GFM",
+        parse_block_html: true,
+        syntax_highlighter: "rouge"
+      })
+      @custom_elements = extract_custom_elements
+    end
+
+    def root
+      @parsed_dom.root
+    end
+
+    def warnings
+      @parsed_dom.warnings
+    end
+
+    def to_html
+      @parsed_dom.to_html
+    end
+
+    def has_js?
+      !@custom_elements.empty?
+    end
+
+    def to_js
+      bundle = ["const EXAMPLE_HANDLERS = {}"]
+
+      @custom_elements.each do |element|
+        bundle << element.to_js
+        bundle << "EXAMPLE_HANDLERS[\"#{element.id}\"] = #{element.name}"
+      end
+
+      bundle.join("\n\n")
+    end
+
+    def method_missing(id, *attr, &block)
+      @parsed_dom.send(id, attr, &block)
+    end
+
+    def generate_el_id(tagname)
+      alphabet = [('a'..'z')].map(&:to_a).flatten
+      tag_id = (0...12).map { alphabet[rand(alphabet.length)] }.join
+      tag_abbr = tagname.split("-").map { |part| part[0] }.join("")
+      "#{tag_abbr}-#{tag_id}"
+    end
+
+    def extract_custom_elements
+      elements = []
+
+      @parsed_dom.root.children.each do |outer_el|
+        if outer_el.type == :html_element && @@custom_elements.keys.include?(outer_el.value)
+
+          unless outer_el.attr.key?("id")
+            outer_el.attr["id"] = generate_el_id(outer_el.value)
+          end
+
+          custom_element_cls = @@custom_elements[outer_el.value]
+          element = custom_element_cls.new(outer_el.attr["id"], outer_el)
+          element.parse_dom
+
+          # codeblocks = outer_el.children.filter { |child_el| child_el.type == :codeblock }
+          #
+          # outer_el.children = codeblocks.map do |codeblock|
+          #   wrapper = Kramdown::Element.new(
+          #     :html_element,
+          #     "example-script",
+          #     { label: LANG_LABELS[codeblock.options[:lang]] },
+          #     { content_model: :block }
+          #   )
+          #   wrapper.children << codeblock
+          #   wrapper
+          # end
+          #
+          # outer_el.children.first.attr[:selected] = true
+
+          elements << element
+        end
+      end
+
+      elements
+    end
+  end
+end

data/lib/kramdown/custom_element.rb

@@ -0,0 +1,13 @@
+module Kramdown
+  class CustomElement
+    attr_reader :id, :outer_el
+
+    def initialize(id, outer_el)
+      @id = id
+      @outer_el = outer_el
+    end
+
+    def parse_dom
+    end
+  end
+end

data/lib/kramdown-components.rb

@@ -0,0 +1,2 @@
+require_relative "kramdown/custom_document"
+require_relative "kramdown/custom_element"

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-components
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Rickerby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mix and match HTML and Markdown syntax. Generate nested DOM trees from
+  a single top level element.
+email: me@maetl.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- kramdown-components.gemspec
+- lib/kramdown-components.rb
+- lib/kramdown/custom_document.rb
+- lib/kramdown/custom_element.rb
+homepage: https://github.com/maetl/kramdown-components
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Rewrite sections of Markdown documents using HTML Custom Elements.
+test_files: []