rich_text_renderer 0.1.0

data/spec/lib/rich_text_renderer/block_renderers/heading_one_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::HeadingOneRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h1' do
+      expect(subject.render(mock_node)).to eq "<h1>foo</h1>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h1><b>foo</b></h1>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/heading_six_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::HeadingSixRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h6' do
+      expect(subject.render(mock_node)).to eq "<h6>foo</h6>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h6><b>foo</b></h6>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/heading_three_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::HeadingThreeRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h3' do
+      expect(subject.render(mock_node)).to eq "<h3>foo</h3>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h3><b>foo</b></h3>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/heading_two_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::HeadingTwoRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h2' do
+      expect(subject.render(mock_node)).to eq "<h2>foo</h2>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h2><b>foo</b></h2>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/hr_renderer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+mock_node = {"nodeType" => "hr"}
+
+describe RichTextRenderer::HrRenderer do
+  subject { described_class.new }
+
+  describe '#render' do
+    it 'will render an hr' do
+      expect(subject.render(mock_node)).to eq '<hr />'
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/hyperlink_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"data" => {"uri" => "https://foobar.com"}, "content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"data" => {"uri" => "https://foobar.com"}, "content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::HyperlinkRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders an a' do
+      expect(subject.render(mock_node)).to eq '<a href="https://foobar.com">foo</a>'
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq '<a href="https://foobar.com"><b>foo</b></a>'
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/list_item_renderer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::ListItemRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a li' do
+      expect(subject.render(mock_node)).to eq "<li>foo</li>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<li><b>foo</b></li>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/ordered_list_renderer_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+mock_node = {"content" => [
+  {
+    "content" => [{
+      "content" => [{
+        "value" => "foo",
+        "nodeType" => "text",
+        "nodeClass" => "text"
+      }],
+      "nodeType" => "paragraph",
+      "nodeClass" => "block"
+    }],
+    "nodeType" => "list-item",
+    "nodeClass" => "block"
+  }]
+}
+
+mock_node_with_marks = {"content" => [
+  {
+    "content" => [{
+      "content" => [{
+        "marks" => [{"type" => "bold"}],
+        "value" => "foo",
+        "nodeType" => "text",
+        "nodeClass" => "text"
+      }],
+      "nodeType" => "paragraph",
+      "nodeClass" => "block"
+    }],
+    "nodeType" => "list-item",
+    "nodeClass" => "block"
+  }]
+}
+
+
+describe RichTextRenderer::OrderedListRenderer do
+  subject do
+    described_class.new(
+      'paragraph' => RichTextRenderer::ParagraphRenderer,
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer,
+      'list-item' => RichTextRenderer::ListItemRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a ol' do
+      expect(subject.render(mock_node)).to eq "<ol><li><p>foo</p></li></ol>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<ol><li><p><b>foo</b></p></li></ol>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/paragraph_renderer_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+mock_node_with_multiple_content_nodes = {"content" => [{"value" => "foo", "nodeType" => "text"}, {"value" => " bar", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe RichTextRenderer::ParagraphRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a p' do
+      expect(subject.render(mock_node)).to eq "<p>foo</p>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<p><b>foo</b></p>"
+    end
+
+    it 'will properly render multiple content nodes' do
+      expect(subject.render(mock_node_with_multiple_content_nodes)).to eq "<p>foo<b> bar</b></p>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/unordered_list_renderer_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+mock_node = {"content" => [
+  {
+    "content" => [{
+      "content" => [{
+        "value" => "foo",
+        "nodeType" => "text",
+        "nodeClass" => "text"
+      }],
+      "nodeType" => "paragraph",
+      "nodeClass" => "block"
+    }],
+    "nodeType" => "list-item",
+    "nodeClass" => "block"
+  }]
+}
+
+mock_node_with_marks = {"content" => [
+  {
+    "content" => [{
+      "content" => [{
+        "marks" => [{"type" => "bold"}],
+        "value" => "foo",
+        "nodeType" => "text",
+        "nodeClass" => "text"
+      }],
+      "nodeType" => "paragraph",
+      "nodeClass" => "block"
+    }],
+    "nodeType" => "list-item",
+    "nodeClass" => "block"
+  }]
+}
+
+
+describe RichTextRenderer::UnorderedListRenderer do
+  subject do
+    described_class.new(
+      'paragraph' => RichTextRenderer::ParagraphRenderer,
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer,
+      'list-item' => RichTextRenderer::ListItemRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a ul' do
+      expect(subject.render(mock_node)).to eq "<ul><li><p>foo</p></li></ul>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<ul><li><p><b>foo</b></p></li></ul>"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/document_renderers/document_renderer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+mock_document = {
+    "nodeType" => "document",
+    "content" => [
+        {
+            "content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}],
+            "nodeType" => "heading-1",
+        }
+    ],
+}
+
+mock_document_with_unknown_nodetype = {
+    "nodeType" => "document",
+    "content" => [
+        {
+            "content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}],
+            "nodeType" => "unknown",
+        }
+    ],
+}
+
+describe RichTextRenderer::DocumentRenderer do
+  subject do
+    described_class.new(
+      'heading-1' => RichTextRenderer::HeadingOneRenderer,
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer,
+      nil => RichTextRenderer::NullRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'propagates rendering to renderers' do
+      expect(subject.render(mock_document)).to eq "<h1><b>foo</b></h1>"
+    end
+
+    it 'will raise an error unknown node types' do
+      expect { subject.render(mock_document_with_unknown_nodetype) }.to raise_error "No renderer defined for 'unknown' nodes"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/null_renderer_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe RichTextRenderer::NullRenderer do
+  subject { described_class.new }
+
+  describe 'null renderer will raise errors for unknown nodes' do
+    it 'will look for nodeType' do
+      expect { subject.render({'nodeType' => 'foo'}) }.to raise_error "No renderer defined for 'foo' nodes"
+    end
+
+    it 'will look for type' do
+      expect { subject.render({'type' => 'foo'}) }.to raise_error "No renderer defined for 'foo' nodes"
+    end
+
+    it 'if none of the above found, will dump the node' do
+      expect { subject.render({'foo' => 'bar'}) }.to raise_error "No renderer defined for '{\"foo\"=>\"bar\"}' nodes"
+    end
+  end
+end

data/spec/lib/rich_text_renderer/renderer_spec.rb

@@ -0,0 +1,308 @@
+require 'spec_helper'
+
+full_document = {
+    "content" => [
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [],
+                    "value" => "Some heading",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "heading-1",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {
+                "target" => {
+                    "sys" => {
+                        "id" => "49rofLvvxCOiIMIi6mk8ai",
+                        "type" => "Link",
+                        "linkType" => "Entry",
+                    }
+                }
+            },
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "embedded-entry-block",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [],
+                    "value" => "Some subheading",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "heading-2",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [{"data" => {}, "type" => "bold", "object" => "mark"}],
+                    "value" => "Some bold",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [{"data" => {}, "type" => "italic", "object" => "mark"}],
+                    "value" => "Some italics",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [{"data" => {}, "type" => "underline", "object" => "mark"}],
+                    "value" => "Some underline",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {
+                "target" => {
+                    "sys" => {
+                        "id" => "5ZF9Q4K6iWSYIU2OUs0UaQ",
+                        "type" => "Link",
+                        "linkType" => "Entry",
+                    }
+                }
+            },
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "embedded-entry-block",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [],
+                    "value" => "Some raw content",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [],
+                    "value" => "An unpublished embed:",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {
+                "target" => {
+                    "sys" => {
+                        "id" => "q2hGXkd5tICym64AcgeKK",
+                        "type" => "Link",
+                        "linkType" => "Entry",
+                    }
+                }
+            },
+            "content" => [
+                {"marks" => [], "value" => "", "nodeType" => "text", "nodeClass" => "text"}
+            ],
+            "nodeType" => "embedded-entry-block",
+            "nodeClass" => "block",
+        },
+        {
+            "data" => {},
+            "content" => [
+                {
+                    "marks" => [],
+                    "value" => "Some more content",
+                    "nodeType" => "text",
+                    "nodeClass" => "text",
+                }
+            ],
+            "nodeType" => "paragraph",
+            "nodeClass" => "block",
+        },
+    ],
+    "nodeType" => "document",
+    "nodeClass" => "document",
+}
+
+describe RichTextRenderer::Renderer do
+  subject { described_class.new }
+
+  describe '#render' do
+    it 'by default renders html' do
+      expect(subject.render(full_document)).to eq [
+        "<h1>Some heading</h1>",
+        "<p></p>",
+        '<div>{"target"=>{"sys"=>{"id"=>"49rofLvvxCOiIMIi6mk8ai", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+        "<h2>Some subheading</h2>",
+        "<p><b>Some bold</b></p>",
+        "<p><i>Some italics</i></p>",
+        "<p><u>Some underline</u></p>",
+        "<p></p>",
+        "<p></p>",
+        '<div>{"target"=>{"sys"=>{"id"=>"5ZF9Q4K6iWSYIU2OUs0UaQ", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+        "<p></p>",
+        "<p>Some raw content</p>",
+        "<p></p>",
+        "<p>An unpublished embed:</p>",
+        "<p></p>",
+        '<div>{"target"=>{"sys"=>{"id"=>"q2hGXkd5tICym64AcgeKK", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+        "<p>Some more content</p>",
+      ].join("\n")
+    end
+  end
+
+  describe 'with all renderers overridden' do
+    subject do
+      described_class.new(
+        'heading-1' => HeadingOneMarkdownRenderer,
+        'heading-2' => HeadingTwoMarkdownRenderer,
+        'paragraph' => ParagraphMarkdownRenderer,
+        'embedded-entry-block' => EntryBlockMarkdownRenderer,
+        'bold' => BoldMarkdownRenderer,
+        'italic' => ItalicMarkdownRenderer,
+        'underline' => UnderlineMarkdownRenderer
+      )
+    end
+
+    it 'renders with the overridden renderers' do
+      expect(subject.render(full_document)).to eq [
+        "# Some heading",
+        "",
+        "",
+        "",
+        "",
+        "```",
+        '{"target"=>{"sys"=>{"id"=>"49rofLvvxCOiIMIi6mk8ai", "type"=>"Link", "linkType"=>"Entry"}}}',
+        "```",
+        "",
+        "## Some subheading",
+        "",
+        "**Some bold**",
+        "",
+        "",
+        "*Some italics*",
+        "",
+        "",
+        "__Some underline__",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "```",
+        '{"target"=>{"sys"=>{"id"=>"5ZF9Q4K6iWSYIU2OUs0UaQ", "type"=>"Link", "linkType"=>"Entry"}}}',
+        "```",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "Some raw content",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "An unpublished embed:",
+        "",
+        "",
+        "",
+        "",
+        "",
+        "```",
+        '{"target"=>{"sys"=>{"id"=>"q2hGXkd5tICym64AcgeKK", "type"=>"Link", "linkType"=>"Entry"}}}',
+        "```",
+        "",
+        "",
+        "Some more content",
+        ""
+      ].join("\n")
+    end
+  end
+end