rich_text_renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a005b745298c66461e9f96c7066f47b0ae964e2102932242a09f0dfc3387e500
+  data.tar.gz: e1533944ead3ffa58ed274598721d99922dee574e3ddaaa54b4103cfd2f60901
+SHA512:
+  metadata.gz: cc2063f0e0aadfab6aca31401f4c5912273c75aeb06d2a421f3e4b33ed143a49b7451af9ba3f515f683e507e93d6c50ba577590285252aa2551d8fb15b11618f
+  data.tar.gz: 8d3380163cb785d1ac0ac6141f599edebd629c32c5cfb274536b50cbbda988cfc2146f7dfd96bc6da3a8a6dc5861e1817b8057e5ac8d4042ba671ee78851a575

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+doc/
+.yardoc/
+coverage
+Gemfile.lock
+.idea
+*.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_from: .rubocop_todo.yml
+
+Encoding:
+  Enabled: false
+
+Metrics/ClassLength:
+  CountComments: false
+
+Metrics/MethodLength:
+  CountComments: false
+
+AllCops:
+  Exclude:
+    - structured_text_renderer.gemspec
+    - spec/**/*
+    - Guardfile
+    - Gemfile
+    - Rakefile
+
+Metrics/ClassLength:
+  Max: 250
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'semantic'

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-02 13:30:13 -0300 using RuboCop version 0.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+Metrics/AbcSize:
+  Max: 38
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 142
+
+# Offense count: 12
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 499
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.1
+  - 2.2.1
+notifications:
+  slack:
+    secure: Zr3mKCiTb0vaTD4MPtTG8BbyYyErFuoxioM25QyrqePKVkDFeZC1MtGmg5klQQrJiWTKZPa/zB8NAHYkoUxg9I+z15JK0hYfz9KRubEpCrXCaqTC9Vzq88kJ3LN8YsTyBF66izaBH2KLsOfaJRxwplFzZqgpg4GG2DUBPtrGtes=
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rake rspec_rubocop
+matrix:
+  allow_failures:
+    - rvm: jruby

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## Unreleased
+
+## v0.1.0 (`rich_text_renderer`)
+
+As `RichText` moves from `alpha` to `beta`, we're treating this as a feature release.
+
+### Changed
+* Renamed `StructuredText` to `RichText`.
+
+## v0.0.2 (`structured_text_renderer`)
+
+### Fixed
+* Fixed rendering logic for block type nodes
+
+## v0.0.1
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+group :green_red_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :yard, cmd: "yard doc" do
+  end
+
+  guard :rubocop, cmd: "rubocop" do
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Contentful GmbH - David Litvak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Contentful Rich Text Renderer
+
+[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
+
+This library provides rendering capabilities for the `RichText` field type. It is recommended to be used alongside the [Contentful Delivery SDK](https://www.github.com/contentful/contentful.rb).
+By default this library will serialize `RichText` fields into it's corresponding HTML representation. All behaviour can be overridden to serialize to different formats.
+
+## Installation
+
+Install Contentful Rich Text Renderer from RubyGems:
+
+```bash
+gem install rich_text_renderer
+```
+
+## Usage
+
+Create a renderer:
+
+```ruby
+require 'rich_text_renderer'
+
+renderer = RichTextRenderer::Renderer.new
+```
+
+Render your document:
+
+```ruby
+renderer.render(document)
+```
+
+## Using different renderers
+
+There are many cases in which HTML serialization is not what you want.
+Therefore, all renderers are overridable when creating a `RichTextRenderer`.
+
+Also, if you're planning to embed entries within your rich text, overriding the `'embedded-entry-block'` mapping is a must,
+as by default it only does `<div>#{entry.to_s}</div>`.
+
+You can override the configuration like follows:
+
+```ruby
+renderer = RichTextRenderer::Renderer.new(
+  'embedded-entry-block' => MyEntryBlockRenderer
+)
+```
+
+Where `MyEntryBlockRenderer` requires to have a `#render(node)` method and needs to return a string.
+
+An example entry renderer, assuming our entry has 2 fields called `name` and `description` could be:
+
+```ruby
+class MyEntryBlockRenderer < RichTextRenderer::BaseNodeRenderer
+  def render(node)
+    entry = node['data']
+
+    "<div class='my-entry'><h3>#{entry.name}</h3><p><small>#{entry.description}</p></small></div>"
+  end
+end
+```
+
+## Dealing with unknown node types
+
+By default, this gem will treat all unknown node types as errors and will raise an exception letting the user know which node mapping is missing.
+If you wish to remove this behaviour then replace the `nil` key of the mapping with a NullRenderer that returns an empty string, or something similar.
+
+An example would be like follows:
+
+```ruby
+class SilentNullRenderer < RichTextRenderer::BaseNodeRenderer
+  def render(node)
+    ""
+  end
+end
+
+renderer = RichTextRenderer::Renderer.new(
+  nil => SilentNullRenderer
+)
+```
+
+## License
+
+Copyright (c) 2018 Contentful GmbH. See [LICENSE](./LICENSE) for further details.
+
+## Contributing
+
+Feel free to improve this tool by submitting a Pull Request.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn 'Run `gem install bundler` to install Bundler.'
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems.'
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task rspec_rubocop: %w(spec rubocop)
+
+task test: :spec
+task default: :spec

data/lib/rich_text_renderer.rb

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

data/lib/rich_text_renderer/base_node_renderer.rb

@@ -0,0 +1,18 @@
+module RichTextRenderer
+  # Base class for all NodeRenderers
+  class BaseNodeRenderer
+    attr_reader :mappings
+
+    def initialize(mappings = {})
+      @mappings = mappings
+    end
+
+    protected
+
+    def find_renderer(node)
+      renderer = mappings[node['nodeType']]
+      return mappings[nil].new(mappings) if renderer.nil? && mappings.key?(nil)
+      renderer.new(mappings) unless renderer.nil?
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers.rb

@@ -0,0 +1,18 @@
+require_relative './block_renderers/hr_renderer'
+
+require_relative './block_renderers/paragraph_renderer'
+require_relative './block_renderers/hyperlink_renderer'
+require_relative './block_renderers/blockquote_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/rich_text_renderer/block_renderers/base_block_renderer.rb

@@ -0,0 +1,24 @@
+require_relative '../base_node_renderer'
+
+module RichTextRenderer
+  # Base renderer for block type nodes
+  class BaseBlockRenderer < BaseNodeRenderer
+    # Renders block type nodes.
+    def render(node)
+      "<#{render_tag}>#{render_content(node)}</#{render_tag}>"
+    end
+
+    protected
+
+    def render_content(node)
+      node['content'].each_with_object([]) do |content_node, result|
+        renderer = find_renderer(content_node)
+        result << renderer.render(content_node)
+      end.join
+    end
+
+    def render_tag
+      'div'
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers/blockquote_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/entry_block_renderer.rb

@@ -0,0 +1,13 @@
+require_relative '../base_node_renderer'
+
+module RichTextRenderer
+  # Default embedded entry renderer.
+  # Dumps entry to string.
+  # This renderer should be overridden for your particular applications.
+  class EntryBlockRenderer < BaseNodeRenderer
+    # Renders embedded entry node.
+    def render(node)
+      "<div>#{node['data']}</div>"
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers/heading_five_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/heading_four_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/heading_one_renderer.rb

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

data/lib/rich_text_renderer/block_renderers/heading_six_renderer.rb

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