kramdown-components 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12fd7ba367f8b2ff86e9e6d313781b88757b37c456a94654ade598c0b47df41
-  data.tar.gz: 7a02bd99bce593452e2d3f510718b474a1acc894c730d66e1f9eba07ecd3e0bd
+  metadata.gz: 5b94ad5f5cdccaf95fc96b86f44a27ece8f9b19ccd464e99d0b7de3b7bbd5a3a
+  data.tar.gz: 0d6aefeddcd1f1b13450895fcaa667fb21988ab57b2056492d50988d8034f543
 SHA512:
-  metadata.gz: 6db57afee5989ac53ab2cd7b1668e9f110fd88e1da20195f724a218c4d59530487ed8bd095267441e9805b046a321530118c53382bed55783df63fc5e7bbbf39
-  data.tar.gz: e86b0cd86885dce1175a6384b03f037f39d32cc962e1d5ad176f37604e38008a0f884f125f150fc119f6fd2f1ab34fe4234ac532b6fbe549bbdb0e2cdc4b5589
+  metadata.gz: 465fabbc525bb9db36097702ecced4e2cee92e9730e68008c0b101a2415c1823fc9233ea0341c3b187338c1bac6f6c2ead11af0da24cdbb1287dda73ca38908b
+  data.tar.gz: e27405070724c9cb7f9011ae24cbb92ba5a5f805b7d09c8a7b0e3b51dbce364dc9649f6c64094c4a315720c9ba512ee2c344f4aff8d1490941b8fc1869146c65

data/.gitignore

@@ -0,0 +1 @@
+kramdown-components-*.gem

data/README.md

@@ -22,10 +22,65 @@ doc = Kramdown::CustomDocument("# Title")
 puts doc.to_html
 ```
 
-### Registration Phase
+### Registering Components
 
-```rb
+To define a custom element that can wrap child elements with the Markdown document, use the `define_element` class method to set the tag name.
 
+```ruby
+Kramdown::CustomDocument.define_element("wrapped-block")
+```
+
+You can customise the behaviour of components by extending `CustomElement` and binding the class to the tag name.
+
+```ruby
+class ImageGallery < Kramdown::CustomElement; end
+
+Kramdown::CustomDocument.define_element("image-gallery", ImageGallery)
+```
+
+### DOM Rewriting
+
+To rewrite DOM subtrees wrapped by the component, implement the `parse_dom` method of `CustomElement` and manipulate the internal `root` and `children` elements, with instances of `Kramdown::Element` to represent each node.
+
+```ruby
+class ButtonList < Kramdown::CustomElement
+  def parse_dom(root)
+    uls = root.children.filter { |child_el| child_el.type == :ul }
+    uls.each do |ul|
+      ul.children.each do |li|
+        button = Kramdown::Element.new(:html_element, "button")
+        button.children = li.children
+        li.children = [button]
+      end
+    end
+  end
+end
+
+Kramdown::CustomDocument.define_element("button-list", ButtonList)
+```
+
+When the `ButtonList#parse_dom` rewrite is applied, all child lists nested within the `<button-list>` component to have the content of each list item wrapped in a `<button>`.
+
+**Source:**
+
+```md
+<button-list>
+
+- One
+- Two
+- Three
+
+</button-list>
 ```
 
-### Compile Phase
+**Result:**
+
+```html
+<button-list id="bl-uftcpsbnzytd">
+  <ul>
+    <li><button>One</button></li>
+    <li><button>Two</button></li>
+    <li><button>Three</button></li>
+  </ul>
+</button-list>
+```

data/kramdown-components.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "kramdown-components"
-  spec.version = "0.0.1"
+  spec.version = "0.1.0"
   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."

data/lib/kramdown/custom_document.rb

@@ -74,8 +74,8 @@ module Kramdown
           end
 
           custom_element_cls = @@custom_elements[outer_el.value]
-          element = custom_element_cls.new(outer_el.attr["id"], outer_el)
-          element.parse_dom
+          element = custom_element_cls.new(outer_el.attr["id"])
+          element.parse_dom(outer_el)
 
           # codeblocks = outer_el.children.filter { |child_el| child_el.type == :codeblock }
           #

data/lib/kramdown/custom_element.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-components
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mark Rickerby