structured_text_renderer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d51d294c923676f4c5663d139b9b33a6f4e1991c454777d4ea7294352d8bdcf2
+  data.tar.gz: 38103cd1b5ed95db1638932d859e9e8d8e5f292b1c19ec9d1819dbf05cd82349
+SHA512:
+  metadata.gz: dc77f8c124c2dc9d1dfc1a96355091223f94e44bb5ead763d0fa0ad58bd66038bbde2f132a6626bc598d63573753584f4e452b2092348f8947bd7cb9843337b1
+  data.tar.gz: 6d6c075c0a1980e50b034a919ac7c96ba09ab79cbc5ca55f09c2861662b96c0489008aefea8d38ce46a51a637c835f9a5449cfaba29f97cd8b9f1b4a6379d5ee

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,5 @@
+# CHANGELOG
+
+## v0.0.1
+
+* Initial Release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    structured_text_renderer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    guard-yard (2.2.1)
+      guard (>= 1.1.0)
+      yard (>= 0.7.0)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    rubygems-tasks (0.2.4)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  guard
+  guard-rspec
+  guard-rubocop
+  guard-yard
+  rake (< 11.0)
+  rspec (~> 3)
+  rubocop (~> 0.49.1)
+  rubygems-tasks (~> 0.2)
+  simplecov
+  structured_text_renderer!
+  yard
+
+BUNDLED WITH
+   1.16.3

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 Structured 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 `StructuredText` 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 `StructuredText` fields into it's corresponding HTML representation. All behaviour can be overridden to serialize to different formats.
+
+## Installation
+
+Install Contentful Structured Text Renderer from RubyGems:
+
+```bash
+gem install structured_text_renderer
+```
+
+## Usage
+
+Create a renderer:
+
+```ruby
+require 'structured_text_renderer'
+
+renderer = StructuredTextRenderer::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 `StructuredTextRenderer`.
+
+Also, if you're planning to embed entries within your structured 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 = StructuredTextRenderer::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 < StructuredTextRenderer::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 < StructuredTextRenderer::BaseNodeRenderer
+  def render(node)
+    ""
+  end
+end
+
+renderer = StructuredTextRenderer::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/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}