rich_text_renderer 0.1.0

data/lib/rich_text_renderer/block_renderers/heading_three_renderer.rb

@@ -0,0 +1,12 @@
+require_relative './base_block_renderer'
+
+module RichTextRenderer
+  # H3 node renderer.
+  class HeadingThreeRenderer < BaseBlockRenderer
+    protected
+
+    def render_tag
+      'h3'
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers/heading_two_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/hr_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/hyperlink_renderer.rb

@@ -0,0 +1,11 @@
+require_relative './base_block_renderer'
+
+module RichTextRenderer
+  # a node renderer.
+  class HyperlinkRenderer < BaseBlockRenderer
+    # Renders hyperlink
+    def render(node)
+      "<a href=\"#{node['data']['uri']}\">#{render_content(node)}</a>"
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers/list_item_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/ordered_list_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/paragraph_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/unordered_list_renderer.rb

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

data/lib/rich_text_renderer/document_renderers.rb

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

data/lib/rich_text_renderer/document_renderers/document_renderer.rb

@@ -0,0 +1,13 @@
+require_relative '../base_node_renderer'
+
+module RichTextRenderer
+  # 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/rich_text_renderer/null_renderer.rb

@@ -0,0 +1,19 @@
+require_relative './base_node_renderer'
+
+module RichTextRenderer
+  # 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/rich_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'
+
+# RichTextRenderer Namespace
+module RichTextRenderer
+  # Renderer for RichText 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,
+      'blockquote' => BlockQuoteRenderer,
+      '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 RichText document
+    def render(document)
+      renderer = find_renderer(document)
+      renderer.render(document) unless renderer.nil?
+    end
+  end
+end

data/lib/rich_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/rich_text_renderer/text_renderers/base_inline_renderer.rb

@@ -0,0 +1,17 @@
+require_relative '../base_node_renderer'
+
+module RichTextRenderer
+  # 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/rich_text_renderer/text_renderers/bold_renderer.rb

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

data/lib/rich_text_renderer/text_renderers/code_renderer.rb

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

data/lib/rich_text_renderer/text_renderers/italic_renderer.rb

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

data/lib/rich_text_renderer/text_renderers/text_renderer.rb

@@ -0,0 +1,19 @@
+require_relative '../base_node_renderer'
+
+module RichTextRenderer
+  # 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/rich_text_renderer/text_renderers/underline_renderer.rb

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

data/lib/rich_text_renderer/version.rb

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

data/rich_text_renderer.gemspec

@@ -0,0 +1,30 @@
+require File.expand_path('../lib/rich_text_renderer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rich_text_renderer'
+  gem.version       = RichTextRenderer::VERSION
+  gem.summary       = 'Rich Text Renderer for the Contentful RichText field type'
+  gem.description   = 'Rich Text Renderer for the Contentful RichText field type'
+  gem.license       = 'MIT'
+  gem.authors       = ['Contentful GmbH (David Litvak Bruno)']
+  gem.email         = 'rubygems@contentful.com'
+  gem.homepage      = 'https://github.com/contentful/rich-text-renderer.rb'
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'rake', '< 11.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-rubocop'
+  gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rubocop', '~> 0.49.1'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/lib/rich_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 RichTextRenderer::BaseBlockRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::BoldRenderer,
+      'italic' => RichTextRenderer::ItalicRenderer,
+      'underline' => RichTextRenderer::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/rich_text_renderer/block_renderers/blockquote_renderer_spec.rb

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

data/spec/lib/rich_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 RichTextRenderer::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/rich_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 RichTextRenderer::HeadingFiveRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::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/rich_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 RichTextRenderer::HeadingFourRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer,
+      'bold' => RichTextRenderer::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