rich_text_renderer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a005b745298c66461e9f96c7066f47b0ae964e2102932242a09f0dfc3387e500
-  data.tar.gz: e1533944ead3ffa58ed274598721d99922dee574e3ddaaa54b4103cfd2f60901
+  metadata.gz: 1af73f4a930b3c68dcf396b334a9318b1fb83ca3ba817582534f4c72b112e210
+  data.tar.gz: 8c92ee30ffe286b8c89532828eff36f4b7b2b123165691c95af3a49f92b8335f
 SHA512:
-  metadata.gz: cc2063f0e0aadfab6aca31401f4c5912273c75aeb06d2a421f3e4b33ed143a49b7451af9ba3f515f683e507e93d6c50ba577590285252aa2551d8fb15b11618f
-  data.tar.gz: 8d3380163cb785d1ac0ac6141f599edebd629c32c5cfb274536b50cbbda988cfc2146f7dfd96bc6da3a8a6dc5861e1817b8057e5ac8d4042ba671ee78851a575
+  metadata.gz: 5c425f17916e5485f1074c75e5f55e9459e92dbd51d7608a42fe2253795baa2df5be419f59dba5684fa7ca501ff990621cddedb1c32361468e39783963298a08
+  data.tar.gz: c84e55adf160d7370ddf868fe31ae708b7634241e3002814cf565d3fa99b0d0c365658941f2ff377b01342a2d9c2f032228ec83ff65849b35fcfbd6b86c78b3e

data/.rubocop.yml

@@ -24,4 +24,4 @@ Style/MutableConstant:
   Enabled: false
 
 Style/SignalException:
-  EnforcedStyle: 'semantic'
+  EnforcedStyle: 'only_fail'

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## v0.2.0
+
+### Added
+* Add Asset support
+
 ## v0.1.0 (`rich_text_renderer`)
 
 As `RichText` moves from `alpha` to `beta`, we're treating this as a feature release.

data/lib/rich_text_renderer/block_renderers.rb

@@ -5,6 +5,8 @@ require_relative './block_renderers/hyperlink_renderer'
 require_relative './block_renderers/blockquote_renderer'
 
 require_relative './block_renderers/entry_block_renderer'
+require_relative './block_renderers/asset_block_renderer'
+require_relative './block_renderers/asset_hyperlink_renderer'
 
 require_relative './block_renderers/heading_one_renderer'
 require_relative './block_renderers/heading_two_renderer'

data/lib/rich_text_renderer/block_renderers/asset_block_renderer.rb

@@ -0,0 +1,27 @@
+require_relative './asset_hyperlink_renderer'
+
+module RichTextRenderer
+  # Asset block renderer
+  class AssetBlockRenderer < AssetHyperlinkRenderer
+    # IMG HTML Tag
+    IMAGE_HTML = ->(url, text) { "<img src=\"#{url}\" alt=\"#{text}\" />" }
+
+    protected
+
+    def render_asset(asset, node = nil)
+      if asset.file.respond_to?(:content_type) && asset.file.content_type.include?('image')
+        return render!(IMAGE_HTML, asset.url, asset.title)
+      end
+
+      super
+    end
+
+    def render_hash(asset, node = nil)
+      if asset.fetch('fields', {}).fetch('file', {}).fetch('contentType', '').include?('image')
+        return render!(IMAGE_HTML, asset['fields']['file']['url'], asset['fields']['title'])
+      end
+
+      super
+    end
+  end
+end

data/lib/rich_text_renderer/block_renderers/asset_hyperlink_renderer.rb

@@ -0,0 +1,64 @@
+require_relative './base_block_renderer'
+
+module RichTextRenderer
+  # Asset hyperlink renderer
+  class AssetHyperlinkRenderer < BaseBlockRenderer
+    # Anchor HTML Tag
+    ANCHOR_HTML = ->(url, text) { "<a href=\"#{url}\">#{text}</a>" }
+
+    # Renders asset nodes
+    def render(node)
+      asset = nil
+      begin
+        asset = node['data']['target']
+      rescue
+        fail "Node target is not an asset - Node: #{node}"
+      end
+
+      # Check by class name instead of instance type to
+      # avoid dependending on the Contentful SDK.
+      return render_asset(asset, node) if asset.class.ancestors.map(&:to_s).any? { |name| name.include?('Asset') }
+
+      if asset.is_a?(::Hash)
+        unless asset.key?('fields') && asset['fields'].key?('file')
+          fail "Node target is not an asset - Node: #{node}"
+        end
+
+        return render_hash(asset, node)
+      end
+
+      fail "Node target is not an asset - Node: #{node}"
+    end
+
+    protected
+
+    def render_asset(asset, node = nil)
+      render!(
+        ANCHOR_HTML,
+        asset.url,
+        renders_node?(node) ? node : asset.title,
+        renders_node?(node)
+      )
+    end
+
+    def render_hash(asset, node = nil)
+      render!(
+        ANCHOR_HTML,
+        asset['fields']['file']['url'],
+        renders_node?(node) ? node : asset['fields']['title'],
+        renders_node?(node)
+      )
+    end
+
+    def renders_node?(node)
+      !(node.nil? || node.empty?) && (
+        node.is_a?(::Hash) ? renders_node?(node['content']) : true
+      )
+    end
+
+    def render!(markup, url, text, formatted = false)
+      text = render_content(text) if formatted
+      markup[url, text]
+    end
+  end
+end

data/lib/rich_text_renderer/renderer.rb

@@ -25,6 +25,8 @@ module RichTextRenderer
       'ordered-list' => OrderedListRenderer,
       'unordered-list' => UnorderedListRenderer,
       'embedded-entry-block' => EntryBlockRenderer,
+      'embedded-asset-block' => AssetBlockRenderer,
+      'asset-hyperlink' => AssetHyperlinkRenderer,
       'hr' => HrRenderer,
       'text' => TextRenderer,
       'bold' => BoldRenderer,

data/lib/rich_text_renderer/version.rb

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

data/spec/lib/rich_text_renderer/block_renderers/asset_block_renderer_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+mock_image_asset_node = {
+  'data' => {
+    'target' => {
+      'fields' => {
+        'title' => 'Foo',
+        'file' => {
+          'contentType' => 'image/jpeg',
+          'url' => 'https://example.com/cat.jpg',
+        },
+      }
+    }
+  }
+}
+
+mock_image_asset_resolved_node = {
+  'data' => {
+    'target' => MockAsset.new(
+      {
+        'fields' => {
+          'title' => 'Foo',
+          'file' => {
+            'contentType' => 'image/jpeg',
+            'url' => 'https://example.com/cat.jpg',
+          },
+        }
+      }
+    )
+  }
+}
+
+mock_non_image_asset_node = {
+  'data' => {
+    'target' => {
+      'fields' => {
+        'title' => 'Foo',
+        'file' => {
+          'contentType' => 'text/csv',
+          'url' => 'https://example.com/cat.csv',
+        },
+      }
+    }
+  }
+}
+
+mock_non_image_asset_resolved_node = {
+  'data' => {
+    'target' => MockAsset.new(
+      {
+        'fields' => {
+          'title' => 'Foo',
+          'file' => {
+            'contentType' => 'text/csv',
+            'url' => 'https://example.com/cat.csv',
+          },
+        }
+      }
+    )
+  }
+}
+
+describe RichTextRenderer::AssetBlockRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders an image asset hash as img' do
+      expect(subject.render(mock_image_asset_node)).to eq '<img src="https://example.com/cat.jpg" alt="Foo" />'
+    end
+
+    it 'renders an image asset object as img' do
+      expect(subject.render(mock_image_asset_resolved_node)).to eq '<img src="https://example.com/cat.jpg" alt="Foo" />'
+    end
+
+    it 'renders a non image hash as an a' do
+      expect(subject.render(mock_non_image_asset_node)).to eq '<a href="https://example.com/cat.csv">Foo</a>'
+    end
+
+    it 'renders a non image object as an a' do
+      expect(subject.render(mock_non_image_asset_resolved_node)).to eq '<a href="https://example.com/cat.csv">Foo</a>'
+    end
+
+    describe 'errors' do
+      it 'raises exception when node is not a data node' do
+        expect { subject.render({}) }.to raise_exception 'Node target is not an asset - Node: {}'
+      end
+
+      it 'raises exception when target is nil' do
+        expect { subject.render({ 'data' => { 'target' => nil }}) }.to raise_exception 'Node target is not an asset - Node: {"data"=>{"target"=>nil}}'
+      end
+
+      it 'raises exception when target does not contain asset fields' do
+        expect { subject.render({ 'data' => { 'target' => {} }}) }.to raise_exception 'Node target is not an asset - Node: {"data"=>{"target"=>{}}}'
+      end
+    end
+  end
+end

data/spec/lib/rich_text_renderer/block_renderers/asset_hyperlink_renderer_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+mock_asset_hyperlink_node = {
+  'data' => {
+    'target' => MockAsset.new(
+      {
+        'fields' => {
+          'title' => 'Foo',
+          'file' => {
+            'contentType' => 'image/jpeg',
+            'url' => 'https://example.com/cat.jpg',
+          },
+        }
+      }
+    )
+  },
+  'content' => [{'value' => 'Example', 'nodeType' => 'text', 'marks' => []}],
+}
+
+describe RichTextRenderer::AssetHyperlinkRenderer do
+  subject do
+    described_class.new(
+      'text' => RichTextRenderer::TextRenderer
+    )
+  end
+
+  describe '#render' do
+    it 'renders an a' do
+      expect(subject.render(mock_asset_hyperlink_node)).to eq '<a href="https://example.com/cat.jpg">Example</a>'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,6 +9,29 @@ RSpec.configure do |config|
   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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rich_text_renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -282,6 +282,8 @@ files:
 - lib/rich_text_renderer.rb
 - lib/rich_text_renderer/base_node_renderer.rb
 - lib/rich_text_renderer/block_renderers.rb
+- lib/rich_text_renderer/block_renderers/asset_block_renderer.rb
+- lib/rich_text_renderer/block_renderers/asset_hyperlink_renderer.rb
 - lib/rich_text_renderer/block_renderers/base_block_renderer.rb
 - lib/rich_text_renderer/block_renderers/blockquote_renderer.rb
 - lib/rich_text_renderer/block_renderers/entry_block_renderer.rb
@@ -310,6 +312,8 @@ files:
 - lib/rich_text_renderer/text_renderers/underline_renderer.rb
 - lib/rich_text_renderer/version.rb
 - rich_text_renderer.gemspec
+- spec/lib/rich_text_renderer/block_renderers/asset_block_renderer_spec.rb
+- spec/lib/rich_text_renderer/block_renderers/asset_hyperlink_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/base_block_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/blockquote_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/entry_block_renderer_spec.rb
@@ -360,6 +364,8 @@ signing_key:
 specification_version: 4
 summary: Rich Text Renderer for the Contentful RichText field type
 test_files:
+- spec/lib/rich_text_renderer/block_renderers/asset_block_renderer_spec.rb
+- spec/lib/rich_text_renderer/block_renderers/asset_hyperlink_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/base_block_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/blockquote_renderer_spec.rb
 - spec/lib/rich_text_renderer/block_renderers/entry_block_renderer_spec.rb