structured_text_renderer 0.0.1

data/lib/structured_text_renderer/block_renderers/heading_two_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # H2 node renderer.
+  class HeadingTwoRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'h2'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/hr_renderer.rb

@@ -0,0 +1,11 @@
+require_relative '../base_node_renderer'
+
+module StructuredTextRenderer
+  # hr node renderer
+  class HrRenderer < BaseNodeRenderer
+    # Renders an hr node
+    def render(_node)
+      '<hr />'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/hyperlink_renderer.rb

@@ -0,0 +1,15 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # a node renderer.
+  class HyperlinkRenderer < BaseBlockRenderer
+    # Renders hyperlink
+    def render(node)
+      content = node['content'].each_with_object([]) do |content_node, result|
+        renderer = find_renderer(content_node)
+        result << renderer.render(content_node)
+      end.join
+      "<a href=\"#{node['data']['uri']}\">#{content}</a>"
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/list_item_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # li node renderer.
+  class ListItemRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'li'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/ordered_list_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # ol node renderer.
+  class OrderedListRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'ol'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/paragraph_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # P node renderer.
+  class ParagraphRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'p'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/quote_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # blockquote node renderer.
+  class QuoteRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'blockqoute'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers/unordered_list_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module StructuredTextRenderer
+  # ul node renderer.
+  class UnorderedListRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'ul'
+    end
+  end
+end

data/lib/structured_text_renderer/block_renderers.rb

@@ -0,0 +1,18 @@
+require_relative './block_renderers/hr_renderer'
+
+require_relative './block_renderers/quote_renderer'
+require_relative './block_renderers/paragraph_renderer'
+require_relative './block_renderers/hyperlink_renderer'
+
+require_relative './block_renderers/entry_block_renderer'
+
+require_relative './block_renderers/heading_one_renderer'
+require_relative './block_renderers/heading_two_renderer'
+require_relative './block_renderers/heading_six_renderer'
+require_relative './block_renderers/heading_five_renderer'
+require_relative './block_renderers/heading_four_renderer'
+require_relative './block_renderers/heading_three_renderer'
+
+require_relative './block_renderers/list_item_renderer'
+require_relative './block_renderers/ordered_list_renderer'
+require_relative './block_renderers/unordered_list_renderer'

data/lib/structured_text_renderer/document_renderers/document_renderer.rb

@@ -0,0 +1,13 @@
+require_relative '../base_node_renderer'
+
+module StructuredTextRenderer
+  # Document renderer.
+  class DocumentRenderer < BaseNodeRenderer
+    # Renders all nodes in the document.
+    def render(document)
+      document['content'].each_with_object([]) do |node, result|
+        result << find_renderer(node).render(node)
+      end.join("\n")
+    end
+  end
+end

data/lib/structured_text_renderer/document_renderers.rb

@@ -0,0 +1 @@
+require_relative './document_renderers/document_renderer'

data/lib/structured_text_renderer/null_renderer.rb

@@ -0,0 +1,19 @@
+require_relative './base_node_renderer'
+
+module StructuredTextRenderer
+  # Catch-all renderer for missing node types
+  class NullRenderer < BaseNodeRenderer
+    # Will raise an exception indicating the missing node type.
+    def render(node)
+      fail "No renderer defined for '#{node_type(node)}' nodes"
+    end
+
+    private
+
+    def node_type(node)
+      return node['nodeType'] if node.key?('nodeType')
+      return node['type'] if node.key?('type')
+      node
+    end
+  end
+end

data/lib/structured_text_renderer/renderer.rb

@@ -0,0 +1,46 @@
+require_relative './text_renderers'
+require_relative './block_renderers'
+require_relative './document_renderers'
+require_relative './base_node_renderer'
+require_relative './null_renderer'
+
+# StructuredTextRenderer Namespace
+module StructuredTextRenderer
+  # Renderer for StructuredText field from Contentful
+  class Renderer < BaseNodeRenderer
+    # Default Renderers
+    DEFAULT_MAPPINGS = {
+      nil => NullRenderer,
+      'document' => DocumentRenderer,
+      'heading-1' => HeadingOneRenderer,
+      'heading-2' => HeadingTwoRenderer,
+      'heading-3' => HeadingThreeRenderer,
+      'heading-4' => HeadingFourRenderer,
+      'heading-5' => HeadingFiveRenderer,
+      'heading-6' => HeadingSixRenderer,
+      'quote' => QuoteRenderer,
+      'hyperlink' => HyperlinkRenderer,
+      'paragraph' => ParagraphRenderer,
+      'list-item' => ListItemRenderer,
+      'ordered-list' => OrderedListRenderer,
+      'unordered-list' => UnorderedListRenderer,
+      'embedded-entry-block' => EntryBlockRenderer,
+      'hr' => HrRenderer,
+      'text' => TextRenderer,
+      'bold' => BoldRenderer,
+      'code' => CodeRenderer,
+      'italic' => ItalicRenderer,
+      'underline' => UnderlineRenderer
+    }
+
+    def initialize(mappings = {})
+      @mappings = DEFAULT_MAPPINGS.merge(mappings)
+    end
+
+    # Returns a rendered StructuredText document
+    def render(document)
+      renderer = find_renderer(document)
+      renderer.render(document) unless renderer.nil?
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/base_inline_renderer.rb

@@ -0,0 +1,17 @@
+require_relative '../base_node_renderer'
+
+module StructuredTextRenderer
+  # Base renderer for inline nodes.
+  class BaseInlineRenderer < BaseNodeRenderer
+    # Renders inline nodes.
+    def render(node)
+      "<#{render_tag}>#{node['value']}</#{render_tag}>"
+    end
+
+    protected
+
+    def render_tag
+      'span'
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/bold_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_inline_renderer'
+
+module StructuredTextRenderer
+  # B node renderer.
+  class BoldRenderer < BaseInlineRenderer
+    protected
+
+    def render_tag
+      'b'
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/code_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_inline_renderer'
+
+module StructuredTextRenderer
+  # code node renderer.
+  class CodeRenderer < BaseInlineRenderer
+    protected
+
+    def render_tag
+      'code'
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/italic_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_inline_renderer'
+
+module StructuredTextRenderer
+  # I node renderer.
+  class ItalicRenderer < BaseInlineRenderer
+    protected
+
+    def render_tag
+      'i'
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/text_renderer.rb

@@ -0,0 +1,19 @@
+require_relative '../base_node_renderer'
+
+module StructuredTextRenderer
+  # Renderer for Text nodes.
+  class TextRenderer < BaseNodeRenderer
+    # Renders text nodes with all markings.
+    def render(node)
+      node = Marshal.load(Marshal.dump(node)) # Clone the node
+
+      node.fetch('marks', []).each do |mark|
+        renderer = mappings[mark['type']]
+        return mappings[nil].new(mappings).render(mark) if renderer.nil? && mappings.key?(nil)
+        node['value'] = renderer.new(mappings).render(node) unless renderer.nil?
+      end
+
+      node['value']
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers/underline_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_inline_renderer'
+
+module StructuredTextRenderer
+  # U node renderer.
+  class UnderlineRenderer < BaseInlineRenderer
+    protected
+
+    def render_tag
+      'u'
+    end
+  end
+end

data/lib/structured_text_renderer/text_renderers.rb

@@ -0,0 +1,5 @@
+require_relative './text_renderers/text_renderer'
+require_relative './text_renderers/bold_renderer'
+require_relative './text_renderers/code_renderer'
+require_relative './text_renderers/italic_renderer'
+require_relative './text_renderers/underline_renderer'

data/lib/structured_text_renderer/version.rb

@@ -0,0 +1,4 @@
+module StructuredTextRenderer
+  # Gem Version
+  VERSION = '0.0.1'.freeze
+end

data/lib/structured_text_renderer.rb

@@ -0,0 +1,2 @@
+require_relative './structured_text_renderer/renderer'
+require_relative './structured_text_renderer/version'

data/spec/lib/structured_text_renderer/block_renderers/base_block_renderer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+mock_node = {"content" => [{"value" => "foo", "nodeType" => "text"}]}
+
+mock_node_with_marks = {"content" => [{"value" => "foo", "nodeType" => "text", "marks" => [{"type" => "bold"}]}]}
+
+describe StructuredTextRenderer::BaseBlockRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::BoldRenderer,
+      'italic' => StructuredTextRenderer::ItalicRenderer,
+      'underline' => StructuredTextRenderer::UnderlineRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'by defaults renders a div' do
+      expect(subject.render(mock_node)).to eq "<div>foo</div>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<div><b>foo</b></div>"
+    end
+  end
+end

data/spec/lib/structured_text_renderer/block_renderers/entry_block_renderer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+mock_data_node = {
+    "data" => {"target" => {"sys" => {"id" => "foo", "type" => "Link", "linkType" => "Entry"}}}
+}
+
+describe StructuredTextRenderer::EntryBlockRenderer do
+  subject { described_class.new }
+
+  describe '#render' do
+    it 'will stringify node data' do
+      expect(subject.render(mock_data_node)).to eq '<div>{"target"=>{"sys"=>{"id"=>"foo", "type"=>"Link", "linkType"=>"Entry"}}}</div>'
+    end
+  end
+end

data/spec/lib/structured_text_renderer/block_renderers/heading_five_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 StructuredTextRenderer::HeadingFiveRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h5' do
+      expect(subject.render(mock_node)).to eq "<h5>foo</h5>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h5><b>foo</b></h5>"
+    end
+  end
+end

data/spec/lib/structured_text_renderer/block_renderers/heading_four_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 StructuredTextRenderer::HeadingFourRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::BoldRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders a h4' do
+      expect(subject.render(mock_node)).to eq "<h4>foo</h4>"
+    end
+
+    it 'will propagate marks to text renderers' do
+      expect(subject.render(mock_node_with_marks)).to eq "<h4><b>foo</b></h4>"
+    end
+  end
+end

data/spec/lib/structured_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 StructuredTextRenderer::HeadingOneRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_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 StructuredTextRenderer::HeadingSixRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_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 StructuredTextRenderer::HeadingThreeRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_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 StructuredTextRenderer::HeadingTwoRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_text_renderer/block_renderers/hr_renderer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+mock_node = {"nodeType" => "hr"}
+
+describe StructuredTextRenderer::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/structured_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 StructuredTextRenderer::HyperlinkRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_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 StructuredTextRenderer::ListItemRenderer do
+  subject do
+    described_class.new(
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::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/structured_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 StructuredTextRenderer::OrderedListRenderer do
+  subject do
+    described_class.new(
+      'paragraph' => StructuredTextRenderer::ParagraphRenderer,
+      'text' => StructuredTextRenderer::TextRenderer,
+      'bold' => StructuredTextRenderer::BoldRenderer,
+      'list-item' => StructuredTextRenderer::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