contentful_middleman 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d430a70041785e3a13f1c6261adc2d876bc20543a00c0be6defbd0e22e6a9eca
-  data.tar.gz: f62729d654a5a66f99d16ffc823acb9acf21d9e58f0fb970f6b70fddce503296
+  metadata.gz: 1307e1d94d361acbb2e3dff98d646982d7b437e8d0998c18ce8b4c8d69ae1e66
+  data.tar.gz: f56e068dd9463f21a02a587f2c69a9e105dc3194c3db267953a2f51f2676c3ae
 SHA512:
-  metadata.gz: 38de6c8762ed8202ad5f722d4ba282029f97f316875c13fd24566867e1e8c0de265d64d6ab992a753c5805c904c4258621fb9b2b1a522599cf3dd28a29e4fd57
-  data.tar.gz: f3520bdc3bb57a5e8031d64a3e8889efcbdfedde90264d5ca733dbe82efa363332709bb252552c4e615f50e738ffdf0d5d901c6c7c3bc73c947b3414f8fe2c2e
+  metadata.gz: 4f02722dce5f2e2be856200bc0162af50f873927432e53f82b45887d1c20f80209659f85b73113480f15bdf434d86c620c0886c8d5e8cbe75a613da709507b00
+  data.tar.gz: bd9b842b364b540c4ef7da32dbb22038c2f01ce887c084f43bd892ddc6224b49623851528bf22a945f1cc32e974fc2ec3de504a675ac1e83cdbcb9cf412425e8

data/.travis.yml

@@ -1,8 +1,7 @@
 rvm:
-  - 2.2.2
-  - 2.2.6
   - 2.3.3
-  - 2.4.0
+  - 2.4.4
+  - 2.5.1
   - jruby
 
 script: "bundle exec rake test"

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 ## Unreleased
 
+## 4.1.0
+### Added
+* *This feature is currently in BETA state, changes may occur as patch fixes* Added support for RichText and added the `rich_text` view helper.
+
 ## 4.0.1
 ### Fixed
 * Allow usage of `use_camel_case` in client options.

data/README.md

@@ -50,20 +50,21 @@ activate :contentful do |f|
 end
 ```
 
-Parameter             | Description
-----------            | ------------
-space                 | Hash with an user choosen name for the space as key and the space id as value
-access_token          | Contentful Delivery API access token
-cda_query             | Hash describing query configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info (look for filter options there). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option. Example: `f.cda_query = { limit: 1000 }`
-client_options        | Hash describing client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb#client-configuration-options) for more info. This option should commonly be used to change Rate Limit Management, Include Resolution, Logging and Proxies.
-content_types         | Hash describing the mapping applied to entries of the imported content types
-default_locale        | String with the value for the default locale for your space. Defaults to `'en-US'`.
-use_preview_api       | Boolean to toggle the used API. Set it to `false` to use `cdn.contentful.com` (default value). Set it to `true` to use `preview.contentful.com`. More info in [the documentation](https://www.contentful.com/developers/documentation/content-delivery-api/#preview-api)
-all_entries           | Boolean to toggle multiple requests to the API for getting over 1000 entries. This uses a naive approach and can get rate limited. When using this, have in mind adding an `order` in your `:cda_query` . Default order is `order: 'sys.createdAt'`
-all_entries_page_size | Integer amount of items per page for `:all_entries` requests, allowing for smaller page sizes on content heavy requests.
-rebuild_on_webhook    | Boolean to toggle Webhook server. Server will run in port 5678, and will be expecting to receive Contentful Webhook calls on `/receive`
-webhook_timeout       | Integer (in seconds) for wait time after Webhook received for rebuilding. Only used if `:rebuild_on_webhook` is true. Defaults to 300 seconds
-webhook_controller    | Class for handling Webhook response, defaults to `::ContentfulMiddleman::WebhookHandler`
+Parameter                | Description
+----------               | ------------
+space                    | Hash with an user choosen name for the space as key and the space id as value.
+access_token             | Contentful Delivery API access token.
+cda_query                | Hash describing query configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info (look for filter options there). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option. Example: `f.cda_query = { limit: 1000 }`.
+client_options           | Hash describing client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb#client-configuration-options) for more info. This option should commonly be used to change Rate Limit Management, Include Resolution, Logging and Proxies.
+content_types            | Hash describing the mapping applied to entries of the imported content types.
+default_locale           | String with the value for the default locale for your space. Defaults to `'en-US'`.
+use_preview_api          | Boolean to toggle the used API. Set it to `false` to use `cdn.contentful.com` (default value). Set it to `true` to use `preview.contentful.com`. More info in [the documentation](https://www.contentful.com/developers/documentation/content-delivery-api/#preview-api)
+all_entries              | Boolean to toggle multiple requests to the API for getting over 1000 entries. This uses a naive approach and can get rate limited. When using this, have in mind adding an `order` in your `:cda_query` . Default order is `order: 'sys.createdAt'`.
+all_entries_page_size    | Integer amount of items per page for `:all_entries` requests, allowing for smaller page sizes on content heavy requests.
+rebuild_on_webhook       | Boolean to toggle Webhook server. Server will run in port 5678, and will be expecting to receive Contentful Webhook calls on `/receive`.
+webhook_timeout          | Integer (in seconds) for wait time after Webhook received for rebuilding. Only used if `:rebuild_on_webhook` is true. Defaults to 300 seconds.
+webhook_controller       | Class for handling Webhook response, defaults to `::ContentfulMiddleman::WebhookHandler`.
+rich_text_mappings | Hash with `'nodeTyoe' => RendererClass` pairs determining overrides for the [`RichTextRenderer` library](https://github.com/contentful/rich-text-renderer.rb) configuration.
 
 You can activate the extension multiple times to import entries from different spaces.
 
@@ -164,6 +165,45 @@ end
 *NOTE*: This kind of Composite Mapper is static, therefore if you want to have multiple combinations of mappers
  for multiple entries, you'd need to write code a bit differently.
 
+### Rich Text *BETA*
+
+To render rich text in your views, you can use the `rich_text` view helper.
+
+An example using `erb`:
+
+```erb
+<% data.my_space.my_type.each do |_, entry| %>
+  <%= rich_text(entry.rich_field) %>
+<% end %>
+```
+
+This will output the generated HTML generated by the [`RichTextRenderer` library](https://github.com/contentful/rich-text-renderer.rb).
+
+#### Adding custom renderers
+
+When using rich text, if you're planning to embed entries, then you need to create your custom renderer for them. You can read how create your own renderer classes [here](https://github.com/contentful/rich-text-renderer.rb#using-different-renderers).
+
+To configure the mappings, you need to add them in your `activate` block like follows:
+
+```ruby
+activate :contentful do |f|
+  # ... all the regular config ...
+  f.rich_text_mappings = { 'embedded-entry-block' => MyCustomRenderer }
+end
+```
+
+You can also add renderers for all other types of nodes if you want to have more granular control over the rendering.
+
+#### Using the helper with multiple activated Contentful extensions
+
+In case you have multiple activated extensions, and have different mapping configurations for them. You can specify which extension instance you want to pull the configuration from when using the helper.
+
+The helper receives an additional optional parameter for the extension instance. By default it is `0`, indicating the first activated extension.
+
+The instances are sequentially numbered in order of activation, starting from 0.
+
+So, if for example you have 2 active instances with different configuration, to use the second instance configuration, you should call the helper as: `rich_text(entry.rich_field, 1)`.
+
 ## Configuration: examples
 
 ```ruby

data/contentful_middleman.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   # Additional dependencies
   s.add_dependency("contentful", '~> 2.1')
   s.add_dependency("contentful-webhook-listener", '~> 0.1')
+  s.add_dependency("rich_text_renderer", '~> 0.1')
 
   s.add_development_dependency 'rubygems-tasks', '~> 0.2'
   s.add_development_dependency "guard"

data/lib/contentful_middleman/core.rb

@@ -52,6 +52,9 @@ module ContentfulMiddleman
     option :webhook_controller, ::ContentfulMiddleman::WebhookHandler,
       "Controller for managing Webhook callbacks"
 
+    option :rich_text_mappings, {},
+      "Custom renderers for the RichTextRenderer library"
+
 
     helpers ContentfulMiddleman::Helpers
     include ContentfulMiddleman::Helpers
@@ -62,6 +65,7 @@ module ContentfulMiddleman
     expose_to_template localize: :localize
     expose_to_template localize_array: :localize_array
     expose_to_template localize_value: :localize_value
+    expose_to_template rich_text: :rich_text
 
     attr_reader :middleman_app
     def initialize(app, options_hash = {}, &block)

data/lib/contentful_middleman/helpers.rb

@@ -1,5 +1,6 @@
 require 'thor/core_ext/hash_with_indifferent_access'
 require 'contentful_middleman/tools/preview_proxy'
+require 'rich_text_renderer'
 
 module ContentfulMiddleman
   module Helpers
@@ -47,5 +48,15 @@ module ContentfulMiddleman
 
       block.call(preview_client)
     end
+
+    def rich_text(document_field, instance_index = 0)
+      mappings = begin
+                   app.extensions[:contentful]["instance_#{instance_index}"].options[:rich_text_mappings] || {}
+                 rescue Exception
+                   {}
+                 end
+
+      RichTextRenderer::Renderer.new(mappings).render(document_field)
+    end
   end
 end

data/lib/contentful_middleman/mappers/base.rb

@@ -61,6 +61,8 @@ module ContentfulMiddleman
           map_entry(value)
         when Array
           map_array(value, locale)
+        when Hash
+          map_hash(value, locale)
         else
           value
         end
@@ -140,6 +142,17 @@ module ContentfulMiddleman
       def map_array(array, locale = nil)
         array.map {|element| map_value(element, locale)}
       end
+
+      def map_hash(hash, locale = nil)
+        return hash.transform_values {|element| map_value(element, locale)} if hash.respond_to?(:transform_values)
+
+        # Support for Ruby versions previous to 2.4
+        result = {}
+        hash.each do |k, v|
+          result[k] = map_value(v, locale)
+        end
+        result
+      end
     end
   end
 end

data/lib/contentful_middleman/version.rb

@@ -1,3 +1,3 @@
 module ContentfulMiddleman
-  VERSION = "4.0.1"
+  VERSION = "4.1.0"
 end

data/spec/contentful_middleman/helpers_spec.rb

@@ -1,7 +1,51 @@
 require 'spec_helper'
 
+class CustomEntryRenderer < RichTextRenderer::BaseNodeRenderer
+  def render(node)
+    "<div>Custom Content</div>"
+  end
+end
+
+class OtherCustomEntryRenderer < RichTextRenderer::BaseNodeRenderer
+  def render(node)
+    "<h1>#{node['data'].body}</h1>"
+  end
+end
+
+class InstanceMock
+  def initialize(mappings = {})
+    @mappings = mappings
+  end
+
+  def options
+    {
+      rich_text_mappings: @mappings
+    }
+  end
+end
+
+class AppMock
+  def initialize(instances = {})
+    @instances = instances
+  end
+
+  def extensions
+    {
+      contentful: @instances
+    }
+  end
+end
+
 class HelpersMock
   include ContentfulMiddleman::Helpers
+
+  def initialize(instances = {})
+    @instances = instances
+  end
+
+  def app
+    AppMock.new(@instances)
+  end
 end
 
 class InstanceDouble
@@ -178,5 +222,109 @@ describe ContentfulMiddleman::Helpers do
         end
       end
     end
+
+    describe 'rich text helpers' do
+      describe '#rich_text' do
+        it 'renders a rich text field to HTML' do
+          expected = [
+            '<h1>Some heading</h1>',
+            '<p></p>',
+            '<div>{"target"=>{"sys"=>{"id"=>"49rofLvvxCOiIMIi6mk8ai", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+            '<h2>Some subheading</h2>',
+            '<p><b>Some bold</b></p>',
+            '<p><i>Some italics</i></p>',
+            '<p><u>Some underline</u></p>',
+            '<p></p>',
+            '<p></p>',
+            '<div>{"target"=>{"sys"=>{"id"=>"5ZF9Q4K6iWSYIU2OUs0UaQ", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+            '<p></p>',
+            '<p>Some raw content</p>',
+            '<p></p>',
+            '<p>An unpublished embed:</p>',
+            '<p></p>',
+            '<div>{"target"=>{"sys"=>{"id"=>"q2hGXkd5tICym64AcgeKK", "type"=>"Link", "linkType"=>"Entry"}}}</div>',
+            '<p>Some more content</p>'
+          ].join("\n")
+
+          expect(subject.rich_text(json('structured_text'))).to eq expected
+        end
+
+        it 'supports multiple configurations' do
+          vcr('helpers/rich_text') {
+            # Instances are a 0-based progressive hash with keys in the shape "instance_#{index}"
+            instances = {
+              "instance_0" => InstanceMock.new('embedded-entry-block' => CustomEntryRenderer),
+              "instance_1" => InstanceMock.new('embedded-entry-block' => OtherCustomEntryRenderer)
+            }
+            subject = HelpersMock.new(instances)
+
+            expected_default = [
+              '<h1>Some heading</h1>',
+              '<p></p>',
+              '<div>Custom Content</div>',
+              '<h2>Some subheading</h2>',
+              '<p><b>Some bold</b></p>',
+              '<p><i>Some italics</i></p>',
+              '<p><u>Some underline</u></p>',
+              '<p></p>',
+              '<p></p>',
+              '<div>Custom Content</div>',
+              '<p></p>',
+              '<p>Some raw content</p>',
+              '<p></p>',
+              '<p>An unpublished embed:</p>',
+              '<p></p>',
+              '<p>Some more content</p>',
+              '<p><code>Some code</code></p>',
+              '<p><a href="https://www.contentful.com">A hyperlink</a></p>',
+              '<ul><li><p>Ul list</p></li><li><p>A few <b>items</b></p><ol><li><p>Ordered list nested inside an Unordered list item</p></li></ol></li></ul>',
+              '<ol><li><p>Ol list</p></li><li><p>two</p></li><li><p>three</p></li></ol>',
+              '<hr />',
+              '<p></p>',
+              '<blockqoute><p>An inspirational quote</p><p></p></blockqoute>',
+              '<p></p>'
+            ].join("\n")
+
+            expected_different_config = [
+              '<h1>Some heading</h1>',
+              '<p></p>',
+              '<h1>Embedded 1</h1>',
+              '<h2>Some subheading</h2>',
+              '<p><b>Some bold</b></p>',
+              '<p><i>Some italics</i></p>',
+              '<p><u>Some underline</u></p>',
+              '<p></p>',
+              '<p></p>',
+              '<h1>Embedded 2</h1>',
+              '<p></p>',
+              '<p>Some raw content</p>',
+              '<p></p>',
+              '<p>An unpublished embed:</p>',
+              '<p></p>',
+              '<p>Some more content</p>',
+              '<p><code>Some code</code></p>',
+              '<p><a href="https://www.contentful.com">A hyperlink</a></p>',
+              '<ul><li><p>Ul list</p></li><li><p>A few <b>items</b></p><ol><li><p>Ordered list nested inside an Unordered list item</p></li></ol></li></ul>',
+              '<ol><li><p>Ol list</p></li><li><p>two</p></li><li><p>three</p></li></ol>',
+              '<hr />',
+              '<p></p>',
+              '<blockqoute><p>An inspirational quote</p><p></p></blockqoute>',
+              '<p></p>'
+            ].join("\n")
+
+            client = Contentful::Client.new(
+              space: 'jd7yc4wnatx3',
+              access_token: '6256b8ef7d66805ca41f2728271daf27e8fa6055873b802a813941a0fe696248',
+              dynamic_entries: :auto,
+              gzip_encoded: false
+            )
+            entry = client.entry('4BupPSmi4M02m0U48AQCSM')
+
+            expect(subject.rich_text(entry.body)).to eq expected_default
+            expect(subject.rich_text(entry.body, 1)).to eq expected_different_config
+          }
+        end
+      end
+    end
   end
 end

data/spec/fixtures/json_fixtures/structured_text.json

@@ -0,0 +1,206 @@
+{
+  "content": [
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [],
+          "value": "Some heading",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "heading-1",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {
+        "target": {
+          "sys": {
+            "id": "49rofLvvxCOiIMIi6mk8ai",
+            "type": "Link",
+            "linkType": "Entry"
+          }
+        }
+      },
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "embedded-entry-block",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [],
+          "value": "Some subheading",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "heading-2",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [{"data": {}, "type": "bold", "object": "mark"}],
+          "value": "Some bold",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [{"data": {}, "type": "italic", "object": "mark"}],
+          "value": "Some italics",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [{"data": {}, "type": "underline", "object": "mark"}],
+          "value": "Some underline",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {
+        "target": {
+          "sys": {
+            "id": "5ZF9Q4K6iWSYIU2OUs0UaQ",
+            "type": "Link",
+            "linkType": "Entry"
+          }
+        }
+      },
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "embedded-entry-block",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [],
+          "value": "Some raw content",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [],
+          "value": "An unpublished embed:",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    },
+    {
+      "data": {
+        "target": {
+          "sys": {
+            "id": "q2hGXkd5tICym64AcgeKK",
+            "type": "Link",
+            "linkType": "Entry"
+          }
+        }
+      },
+      "content": [
+        {"marks": [], "value": "", "nodeType": "text", "nodeClass": "text"}
+      ],
+      "nodeType": "embedded-entry-block",
+      "nodeClass": "block"
+    },
+    {
+      "data": {},
+      "content": [
+        {
+          "marks": [],
+          "value": "Some more content",
+          "nodeType": "text",
+          "nodeClass": "text"
+        }
+      ],
+      "nodeType": "paragraph",
+      "nodeClass": "block"
+    }
+  ],
+  "nodeType": "document",
+  "nodeClass": "document"
+}