rich_text_renderer 0.2.2 → 0.2.3

data/spec/lib/rich_text_renderer/renderer_spec.rb

@@ -1,308 +0,0 @@
-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>{"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>{"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>{"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",
-        "",
-        "",
-        "",
-        "",
-        "```",
-        '{"sys"=>{"id"=>"49rofLvvxCOiIMIi6mk8ai", "type"=>"Link", "linkType"=>"Entry"}}',
-        "```",
-        "",
-        "## Some subheading",
-        "",
-        "**Some bold**",
-        "",
-        "",
-        "*Some italics*",
-        "",
-        "",
-        "__Some underline__",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "```",
-        '{"sys"=>{"id"=>"5ZF9Q4K6iWSYIU2OUs0UaQ", "type"=>"Link", "linkType"=>"Entry"}}',
-        "```",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "Some raw content",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "An unpublished embed:",
-        "",
-        "",
-        "",
-        "",
-        "",
-        "```",
-        '{"sys"=>{"id"=>"q2hGXkd5tICym64AcgeKK", "type"=>"Link", "linkType"=>"Entry"}}',
-        "```",
-        "",
-        "",
-        "Some more content",
-        ""
-      ].join("\n")
-    end
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/base_inline_renderer_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-mock_node = {"value" => "foo"}
-
-describe RichTextRenderer::BaseInlineRenderer do
-  subject { described_class.new }
-
-  it 'renders as a span' do
-    expect(subject.render(mock_node)).to eq "<span>foo</span>"
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/bold_renderer_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-mock_node = {"value" => "foo"}
-
-describe RichTextRenderer::BoldRenderer do
-  subject { described_class.new }
-
-  it 'renders as a b' do
-    expect(subject.render(mock_node)).to eq "<b>foo</b>"
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/code_renderer_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-mock_node = {"value" => "foo"}
-
-describe RichTextRenderer::CodeRenderer do
-  subject { described_class.new }
-
-  it 'renders as a code' do
-    expect(subject.render(mock_node)).to eq "<code>foo</code>"
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/italic_renderer_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-mock_node = {"value" => "foo"}
-
-describe RichTextRenderer::ItalicRenderer do
-  subject { described_class.new }
-
-  it 'renders as a i' do
-    expect(subject.render(mock_node)).to eq "<i>foo</i>"
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/text_renderer_spec.rb

@@ -1,65 +0,0 @@
-require 'spec_helper'
-
-mock_node_underline_only = {"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "underline"}]}
-
-mock_node_italic_only = {"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "italic"}]}
-
-mock_node_bold_only = {"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}
-
-mock_node_multiple_marks = {
-  "value" => "foo",
-  "nodeType" => "text",
-  "marks" => [{"type" => "underline"}, {"type" => "italic"}, {"type" => "bold"}],
-}
-
-mock_node_unsupported_mark = {"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "foobar"}]}
-
-mock_node_unsafe_value = {"value" => "<script>alert('XSS!');</script>", "nodeType" => "text", "marks" => []}
-
-mock_node_unsafe_value_with_marks = {"value" => "<script>alert('XSS!');</script>", "nodeType" => "text", "marks" => [{"type" => "underline"}, {"type" => "italic"}, {"type" => "bold"}]}
-
-describe RichTextRenderer::TextRenderer do
-  subject do
-    described_class.new(
-      'text' => RichTextRenderer::TextRenderer,
-      'bold' => RichTextRenderer::BoldRenderer,
-      'italic' => RichTextRenderer::ItalicRenderer,
-      'underline' => RichTextRenderer::UnderlineRenderer,
-      nil => RichTextRenderer::NullRenderer
-    )
-  end
-
-  describe '#render' do
-    it 'can render with a single mark' do
-      expect(subject.render(mock_node_bold_only)).to eq "<b>foo</b>"
-      expect(subject.render(mock_node_italic_only)).to eq "<i>foo</i>"
-      expect(subject.render(mock_node_underline_only)).to eq "<u>foo</u>"
-    end
-
-    it 'can render multiple marks' do
-      expect(subject.render(mock_node_multiple_marks)).to eq "<b><i><u>foo</u></i></b>"
-    end
-
-    it 'raises an error for unsupported marks' do
-      expect { subject.render(mock_node_unsupported_mark) }.to raise_error "No renderer defined for 'foobar' nodes"
-    end
-
-    it 'supports custom renderers' do
-      subject = described_class.new(
-        'text' => RichTextRenderer::TextRenderer,
-        'bold' => BoldMarkdownRenderer,
-        nil => RichTextRenderer::NullRenderer
-      )
-
-      expect(subject.render(mock_node_bold_only)).to eq "**foo**"
-    end
-
-    it 'escapes value' do
-      expect(subject.render(mock_node_unsafe_value)).to eq "&lt;script&gt;alert(&#39;XSS!&#39;);&lt;/script&gt;"
-    end
-
-    it 'renders marks but keeps value escaped' do
-      expect(subject.render(mock_node_unsafe_value_with_marks)).to eq "<b><i><u>&lt;script&gt;alert(&#39;XSS!&#39;);&lt;/script&gt;</u></i></b>"
-    end
-  end
-end

data/spec/lib/rich_text_renderer/text_renderers/underline_renderer_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-mock_node = {"value" => "foo"}
-
-describe RichTextRenderer::UnderlineRenderer do
-  subject { described_class.new }
-
-  it 'renders as a u' do
-    expect(subject.render(mock_node)).to eq "<u>foo</u>"
-  end
-end

data/spec/spec_helper.rb

@@ -1,105 +0,0 @@
-require 'simplecov'
-SimpleCov.start unless RUBY_PLATFORM == 'java'
-
-require 'rspec'
-require 'rich_text_renderer'
-
-RSpec.configure do |config|
-  config.filter_run :focus => true
-  config.run_all_when_everything_filtered = true
-end
-
-class MockFile
-  attr_reader :content_type, :url
-
-  def initialize(json)
-    @url = json['url']
-    @content_type = json['contentType']
-  end
-end
-
-class MockAsset
-  attr_reader :fields, :file, :title
-
-  def initialize(json)
-    @fields = json['fields']
-    @file = MockFile.new(@fields['file'])
-    @title = @fields['title']
-  end
-
-  def url
-    file.url
-  end
-end
-
-class NodeRenderer
-  attr_reader :mappings
-
-  def initialize(mappings = {})
-    @mappings = mappings
-  end
-
-  protected
-
-  def find_renderer(node)
-    renderer = mappings[node['nodeType']]
-    return if renderer.nil?
-    renderer.new(mappings)
-  end
-end
-
-class HeadingOneMarkdownRenderer < NodeRenderer
-  def render(node)
-    node['content'].each_with_object([]) do |c, res|
-      renderer = find_renderer(c)
-      next if renderer.nil?
-      res << "# #{renderer.render(c)}"
-    end.join("\n")
-  end
-end
-
-class HeadingTwoMarkdownRenderer < NodeRenderer
-  def render(node)
-    node['content'].each_with_object([]) do |c, res|
-      renderer = find_renderer(c)
-      next if renderer.nil?
-      res << "## #{renderer.render(c)}"
-    end.join("\n")
-  end
-end
-
-class ParagraphMarkdownRenderer < NodeRenderer
-  def render(node)
-    paragraphs = node['content'].each_with_object([]) do |c, res|
-      renderer = find_renderer(c)
-      next if renderer.nil?
-      res << "#{renderer.render(c)}"
-    end.join("\n")
-
-    "\n#{paragraphs}\n"
-  end
-end
-
-class EntryBlockMarkdownRenderer < NodeRenderer
-  def render(node)
-    "\n```\n#{node['data']['target']}\n```\n"
-  end
-end
-
-class BoldMarkdownRenderer < NodeRenderer
-  def render(node)
-    "**#{node['value']}**"
-  end
-end
-
-class ItalicMarkdownRenderer < NodeRenderer
-  def render(node)
-    "*#{node['value']}*"
-  end
-end
-
-class UnderlineMarkdownRenderer < NodeRenderer
-  def render(node)
-    "__#{node['value']}__"
-  end
-end